An open source project to bring all front end documentation under one repository.
-
Contribution to this repository is going to be in the form of documentation
-
Preferred language should be English
-
The documentation should be clear, consise and complete
-
The starting letter of every word should be in uppercase, do not use spaces or hyphen(-), instead use underscore (_) to join words
-
Make sure the issue you are creating does not exist or is merged already
1. Fork this repository.
2. Clone your forked copy of the project.
git clone https://github.com/<your_name>/Frontend-Owls
3. Navigate to the project directory 📁 .
cd Frontend-Owls
4. Add a reference(remote) to the original repository.
git remote add upstream https://github.com/HackClubRAIT/Frontend-Owls
5. Check the remotes for this repository.
git remote -v
6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).
git pull upstream main
7. Create a new branch.
git checkout -b <your_branch_name>
8. Perform your desired changes to the code base.
9. Track your changes:heavy_check_mark: .
git add .
10. Commit your changes .
git commit -m "Relevant message"
11. Push the committed changes in your feature branch to your remote repo.
git push -u origin <your_branch_name>
12. To create a pull request, click on compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repository you are supposed to make a PR to.
13. Add appropriate title and description to your pull request explaining your changes and efforts done.
14. Click on Create Pull Request.
15 Voila! You have made a PR to the Frontend-Owls . Sit back patiently and relax while your PR is reviewed.
