Skip to content

Latest commit

 

History

History
93 lines (61 loc) · 3.57 KB

CONTRIBUTING.md

File metadata and controls

93 lines (61 loc) · 3.57 KB
Raw

🤝First time contributing? Check out the tips mentioned 👍

GitHub custom open for collaboration

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.
  • Read the Code of Conduct
  • 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.

⭐Making a Pull Request:

1. Fork this repository.

2. Clone the forked repository. Open terminal and type:

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

3. Navigate to the project directory.

cd Deep-ML

4. Make a feature branch

git checkout -b <branch-name>

5. Make changes in source code/project.

6. Stage your changes and 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 repo.

git push origin <brach-name>

8. Create a PR !

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

🏆 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:memo:

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: https://chris.beams.io/posts/git-commit.

💥 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!🥇