Skip to content

contributing.md

Latest commit

 

History

History
39 lines (26 loc) · 1.92 KB

contributing.md

File metadata and controls

39 lines (26 loc) · 1.92 KB
layout page
title Contribution

Adding a repository

If you wish to add a repository in the organisation, write about the project details at bytes-club@googlegroups.com or drop a message about the repository on the gitter channel #Bytes_Club/General.

For Beginners

  • Introduce yourself by sending a mail to the mailing list ( bytes-club@googlegroups.com ), providing your past experiences. We surely have something for you.
  • If you are a beginner and don't know where to start, head over to the Github page of the organisation, and look for a project which you are interested in.
  • Setup the project by following the Documentation on your local machine (usually the README file).
Creating issues
  • If you find any issues/feature enhancement regarding any project, go to the issues tab and create an issue regarding it.
  • Provide proper labels for the issue. If it is an enhancement use the enhancement label, if it is a bug, use the bug label.
Solving an issue
  • Go to the issues tab, and look for the issues which interests you. If you are a beginner, look for the label dificulty/easy to start with.
  • Work on the issue by forking the repository in your account, work on the issue and create a Pull Request regarding the same. For more details, read the tips for contributing

In case you face any kind of trouble, feel free to ask in the gitter channel #Bytes_Club/General.

Tips for Contribution

  • Create a new branch while working on an issue.
  • Use proper commit messages. A typical commit message should look like this:
shortlog: commit message

commit body

fixes #<issue_number>

For more information about proper commit messages, read this.