Skip to content

Latest commit

 

History

History
81 lines (53 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

81 lines (53 loc) · 2.76 KB
Raw

How to contribute 🤔 ?

  1. Take a look at the existing Issues or create a new issue!
  2. Fork the Repo. Then, create a branch for any issue that you are working on. Finally, commit your work.
  3. Before commiting make sure you are addding the algorithm in the correct folder. Incase a you are adding the algorithm in a new language make sure to create a new folder having the name of that language.
  4. Create a Pull Request (PR), which will be promptly reviewed and given suggestions for improvements by the community.

⛔ Points to be noted 📒🖊 :

  • The code must be added to the correct folder

eg : If you are adding binary search in java, then you should go to folder search / binary_search / then add the code.

  • The code must be named after the language the code is coded

eg: if the code is in java, then name your code as in_Java.java

⭐ HOW TO MAKE A PULL REQUEST:

1. Start by making a Fork of the Sorting-Searching-Algorithms repository. Click on the Fork symbol at the top right corner.

2. Clone your new fork of the repository in the terminal/CLI on your computer with the following command:

git clone https://github.com/<your-github-username>/Sorting-Searching-Algorithms

3. Navigate to the newly created Sorting-Searching-Algorithms project directory:

cd Sorting-Searching-Algorithms

4. Set upstream command:

git remote add upstream https://github.com/4N1Z/Sorting-Searching-Algorithms.git

5. Create a new branch:

git checkout -b YourBranchName

6. Sync your fork or your local repository with the origin repository:

  • In your forked repository, click on "Fetch upstream"
  • Click "Fetch and merge"

7. Make your changes to the source code.

8. Stage your changes:

git add .

or

git add "<files_you_have_changed>"

9. Commit your changes:

git commit -m "<your_commit_message>"

10. Push your local commits to the remote repository:

git push origin YourBranchName

11. Create a Pull Request!

12. Congratulations! You've made your first contribution to this repo!! 🙌🏼

🏆 After this, the maintainers will review the PR and will merge it if it helps move the Sorting-Searching-Algorithms project forward. Otherwise, it will be given constructive feedback and suggestions for the changes needed to add the PR to the codebase.