Skip to content

Latest commit

 

History

History
121 lines (78 loc) · 4.85 KB

CONTRIBUTING.md

File metadata and controls

121 lines (78 loc) · 4.85 KB
Raw

Need Help with contributing. No issues, We will help you out. 🙋

GitHub custom open for collaboration

Refer to the following articles on the basics of Git and Github, in case you are stuck. Use these links:

Getting started with Git and GitHub Forking a Repo Cloning a Repo How to create a Pull Request?

If you don't have git on your machine, install it.

Thanks for taking the time to contribute! 🐱‍
When contributing to this repository, please first discuss the change you wish to make via issue or any other method with the owner of this repository (Manoj Paramsetti) before making a change.

How to Contribute? 💥

PRs Welcome Open Source Love

  • Take a look at the Existing Issues or create your own Issues!
  • Wait for the Issue to be assigned to you after which you can start working on it.
  • Fork the Repo and create a Branch for any Issue that you are working upon.
  • Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
  • Add Screenshots to help us know what this Script is all about.

For adding new Code

  • Create a folder for the topic you wish to add code or if a folder already exists, add your code to it. 📁
  • In the respective folder, add your code file with proper format

For Contribution

1. Fork this repository. Click on the symbol at the top right corner.

2. Clone the forked repository. Open your git bash on your machine in relevant folder

git clone https://github.com/<your-github-username>/Algorithm-Warehouse.git

3. Navigate to the project directory.

cd Algorithm-Warehouse

5. Create a new branch:

git YourBranchName

6. Change to new branch:

git checkout YourBranchName

7. Make changes in source code.

8. Stage your changes and commit

git add "<Your file name along with .(dot)extension>"

e.g., git add file.txt

9. Add the commit to your local repo.

git commit -m "<your_commit_message>"

10. Push your local commits to the remote repository

git push origin YourBranchName

11. Create a pull request

To create a pull request. Visit the pull request

For more details. Visit Hello World

Congratulations! Sit and relax, you've made your contribution to Algorithm-Warehouse project.

After this, repository admin will review the changes and they will merge your PR if they are found good, otherwise we will suggest the required changes.

Style Guides for Git Commit Messages: 📖

Here's a list of some good to have points, that can add more value to your contribution logs.

  • Use the present tense (example: "Add feature" and not "Added feature")

  • Use the imperative mood (example: "Move item to...", instead of "Moves item to...")

  • Limit the first line (also called subject line) to 50 characters or less

  • Capitalize the subject line

  • Separate subject from body with a blank line

  • Do not end the subject line with a period

  • Wrap the body at 72 characters

  • Use the body to explain what, why, vs, and how

  • Reference issues and pull requests liberally after the first line

Issues:

For major changes, you are welcomed to open an issue about what you would like to contribute. Enhancements will be appreciated.

All the Best!🥇

built by developers

Referred from: DSC-SIST/Discord-Bot