Skip to content

Latest commit

 

History

History
100 lines (65 loc) · 3.42 KB

CONTRIBUTING.md

File metadata and controls

100 lines (65 loc) · 3.42 KB
Raw

Hello 👋, First time contributing? No Problem! You can do it easily.

Refer to the following articles on the basics of Git and Github and can also contact the Project Mentors, in case you are stuck:

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

💥 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.

⭐ How To Make A Pull Request

1. Fork this repository.

2. Clone the forked repository.

git clone https://github.com/<your-github-username>/<repository-name>.git

3. Set upstream command.

git remote add upstream https://github.com/<repository-owner-username>/<repository-name>.git

4. Navigate to the project directory.

cd <repository_name>

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 changes in source code.

8. Stage your changes and commit.

git add .
git commit -m "<your_commit_message>"

9. Push your local commits to the remote repository.

git push origin YourBranchName

10. Create a PR!

11. Congratulations! Sit and relax, you've made your contribution.

🏆 After this, project leaders and mentors will review the changes and 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.

For more detailed reference to the above points, refer here.

💥 Issues:

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

All the Best! 🥇