Skip to content

Latest commit

 

History

History
127 lines (74 loc) · 6.26 KB

CONTRIBUTING.md

File metadata and controls

127 lines (74 loc) · 6.26 KB
Raw

Contributing to Open Source Projects Under CodeDocs

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to the Open Source projects which are hosted under CodeDocs. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

What should I know before I get started?

Github

This is the key thing you need to know before hopping onboard, we strongly suggest you go through the below resources if you are not aware of Git & Github principles.

Web Development

  • This project requires basic knowledge of web development for getting started.
  • Knowledge of HTML, CSS, JavaScript.
  • If you know about Jekyll it will be a plus.

How Can I Contribute?

  • Check out the issues on this repository.
  • Comment on the issues before start working on them.
  • Start contributing 🎉.

Reporting Bugs

This section guides you through submitting a bug report for the project. Following these guidelines helps maintainers and the community members in understanding your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.

Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

Note: If you find a Closed issue that seems similar to the one you're experiencing, you should open a new issue and include a link to the original issue in the body of your new one.

Before Submitting A Bug Report

  • Make sure it is actually a bug before you create an issue.
  • Note down the trail, on how the bug was found.
  • Do a small search and check if this issue has already been reported.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. After you've determined what exactly your bug is related to, create an issue on the repository and provide the following information by filling in the template.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.

  • Describe the exact steps which reproduce the problem in as much detail as possible.

  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets on the issue, use Markdown code blocks.

  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.

  • Explain which behavior you expected to see instead and why.

  • Are you able to reproduce the issue? If not, provide details on how often the problem occurs and under which conditions.

Pull Requests

A pull request is a way to contribute to our project, you clone our project, make changes locally and submit a pull request.

Before making a Pull request

  • Fill in pull request template
  • Include screen shots in your pull request whenever possible.
  • Follow our code guidelines.

Here are links and resources to get you started on Pull requests.

Pull Request Template

Most important part of the pull requests are pull request descriptions which should explain the changes in the pull request to others. When making a PR, please fill the PR template and do not delete it.

A pull request title should ideally begin with the name of the file you've edited and should describe what your pull request does in 60 characters or less. In case multiple files are being edited, the PR title should just contain the changes being made in the PR.

Here is an example of a good commit message, for your convenience:

# Title: Describe the change in maximum of 60 characters.
configure.py: Fix docstring typo

# Issue link: Mention the URL of the issue it closes or fixes.
Fixes https://github.com/coala/coala/issues/4018

#Description:  Describe the reasoning behind your changes in a maximum of 80 characters per line.
This fixes the typo and changes
it from wether --> whether.

Here is an example of the bad commit:

Fixing docstring typo in the which was in the spelling of whether.
  • This will take a lot of time for code maintainers to investigate the change and to locate the files in which changes were made.

You can see that the commit is more readable and understandable in the good commit example.

So we would request you to follow our commit guidelines. By following this standard we want to have maintainability of the code.

Project Setup Instructions

Fork the Project

Clone the Project

Git Commit Messages

  • Proper & meaningful commit messages are the best way to keep code maintainable and organized.
  • Always write a commit message, even if it's for small change.