Skip to content

Latest commit

 

History

History
73 lines (49 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

73 lines (49 loc) · 3.09 KB
Raw

Contributing Guidelines

For Beginners

  • Introduce yourself by sending a mail to the mailing list ( [email protected] ), 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 organization, 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.
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>

Signed-off-by: [Your name] <your email>

Keep in mind the following points while writting a commit message

- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how

For more information about proper commit messages, read this.

Coding Conventions

We follow the Linux Kernel's coding convention.

Legal Notice

CS-01: A free course as an introduction to Computer Science in Real life scenario
Copyright (C) 2017-2018  Ayan Chandra, Progyan Bhattacharya, Bytes Club

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; strictly version 2 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

For any query regarding the product, contact:
  Bytes Club Discussion <[email protected]>
  Progyan Bhattacharya <[email protected]>

More about git