workflows-group1-intro
Group 1
Introduction
Welcome to the repository of Group 1, a collaborative effort for the Hack Your Future program. Our team comprises of aspiring web developers who are dedicated to mastering the skills required to build exceptional web applications and create a positive impact in the world.
We firmly believe that the journey to becoming a web developer requires dedication, perseverance, and a supportive community, and we are committed to pushing ourselves beyond our limits to achieve our goals. As a team, we take on challenging projects and assignments, constantly striving to improve our knowledge and skills.
Team Members
Our team comprises the following members, each with a GitLab account:
| Name | GitLab Account |
|---|---|
| Emran Hamdard | emran-ai |
| Gabriellaloy | gabriellaloy |
| Saida | SaidaKF |
| Jeanpaul | jean-paul |
| Tesfalem | Tesfalemm |
| Starry | starrry |
Technologies Used
We are utilizing [VScode] as our code editor and [GitHub] as our version control system.
What We Have Learned So Far
Through the Hack Your Future program, we have gained extensive knowledge in various web development technologies such as Git, GitHub, Node.js, and more. We have also acquired an understanding of best practices for code quality and continuous integration.
Code Quality Checks
We have implemented the following code quality checks to ensure that our code is well-formatted, correctly linted, and free of spelling errors:
- npm run format: Formats all the code in this repository.
- npm run lint:ls: Lints the folder and file names in this repository to ensure they match the repo conventions.
- npm run lint:md: Lints all the Markdown files in this repository and flags any style mistakes to fix.
- npm run spell-check: Goes through all the files in this repository to look for words it doesn’t recognize. Correct words can be added to the ./.cspell.json file to avoid errors.
Continuous Integration (CI)
We have set up GitHub Actions to perform linting checks on the code in this repository when a pull request is made to the main/master branch. If the linting fails, the PR cannot be merged until the code is fixed. This ensures that our code is always of high quality and adheres to our established standards.
Repo Setup
To set up our repository, we have given each member write access to the repo (as it is a group project), turned on GitHub Pages, and activated GitHub Actions. In addition, we have set up the following branch protections to ensure the stability and quality of our code:
- Require a review before pull requests can be merged
- Require status checks to pass before merging
- Require branches to be up to date before merging
We are excited to continue our journey towards becoming successful web developers through the Hack Your Future program, and we are grateful for the opportunity to work together as a team to achieve our goals. Require require branches to be up to date before merging.
Contributions
We welcome contributions from the community and encourage anyone interested in contributing to our project to create a pull request. We would like to express our gratitude to our Coaches for their guidance and support throughout the development of this project
Acknowledgements
We would like to thank our Coaches for their help and support during the development of this project.
