Skip to content

Latest commit

 

History

History
95 lines (58 loc) · 3.89 KB

CONTRIBUTING.md

File metadata and controls

95 lines (58 loc) · 3.89 KB

🖥️ First time contributing? We will help you out.👋🏻

GitHub custom open for collaboration

Refer to the following articles on the basics of Git and GitHub and feel free to contact the Project Mentors if you have any questions:

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

How to Contribute❓

PRs Welcome Open Source Love

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

⭐ How to make a pull request

1. Fork this repository. Click on "Fork" from top right corner.

2. Clone the forked repository.

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

3. Go to the project directory.

cd RepoAppIdea

4. Make modifications to the source code.

5. Stage your changes and make a commit.

#Add changes to Index
git add .

#Commit to the local repo
git commit -m "<your_commit_message>"

7. Push your local commits to the remote repository.

git push

8. Create a Pull Request (PR) !

9. Congratulations! Sit and relax, you've made your contribution to GrabBits project.

🏆 After this, project leaders and mentors will review your changes and merge your PR if they are deemed satisfactory. If changes are required, they will provide suggestions.

Style guide for git commit messages

Here are some helpful points to enhance your contribution logs.

  • Use the present tense (e.g., "Add feature" instead of "Added feature").

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

  • Keep the first line (subject line) within 50 characters or less.

  • Capitalize the subject line.

  • Separate the subject line from the 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, versus, and how.

  • Reference issues and pull requests liberally after the first line.

For more detailed reference to the above points, refer here

🐛 Issues

For significant changes, feel free to open an issue regarding what you would like to contribute. Enhancements are always welcome.

All the Best! 🏆