Wizard-Of-Docs
An open source project to bring all the data structures and algorithms docs under one repository.
Data Structures are the main part of many computer science algorithms as they enable the programmers to handle the data in an efficient way.
What is the type of contribution?
-
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
-
There are two separate folders to contribute data-structures & algorithms respectively
-
Make sure the issue you are creating does not exist or is merged already,issue can be created to write the same code with different logic in different languages (but not the theoritical part)
How to contribute?
1. Fork this repository.
2. Clone your forked copy of the project.
git clone https://github.com/<your_name>/Wizard-Of-Docs
3. Navigate to the project directory
cd Wizard-Of-Docs
4. Add a reference(remote) to the original repository.
git remote add upstream https://github.com/HackClubRAIT/Wizard-Of-Docs
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
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 Wizard-Of-Docs. Sit back patiently and relax while your PR is reviewed
Project Maintainer
