Skip to content

Latest commit

 

History

History
142 lines (103 loc) · 4.98 KB

CONTRIBUTING.md

File metadata and controls

142 lines (103 loc) · 4.98 KB
Raw

Contributing to this project

Anyone and everyone is welcome to contribute, but please take a moment to review this guidelines for contributing to make this process easy and effective for everyone.

Following these guidelines helps to communicate that you respect the time of those developers managing and developing an open source project. In return, they should reciprocate that respect in addressing your issue and assessing patches and features.

If you think this guide can be improved, please share your thoughts.

Using the issue tracker

The issue tracker is the preferred channel for reporting bugs, requesting features and submitting pull requests, but please respect the following restrictions:

  • Please do not use the issue tracker for personal support requests (use StackOverflow or IRC).

  • Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.

Reporting bugs

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports

  1. Use the GitHub issue search — check if the issue has already been reported.

  2. Check if the issue has been fixed — try to reproduce it using the latest master branch in the repository.

  3. Isolate the problem — ideally create a reduced test case and a live example.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs, see this example of a good bug report:

Short and descriptive example bug report title

A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

  1. This is the first step
  2. This is the second step
  3. Further steps, etc.

<url> - a link to the reduced test case

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

Requesting features

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

Enquiring about contributions

Contribution enquiries should take place before any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to pull into the repository.

Submitting pull requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Make sure to adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).

Please follow this process; it's the best way to get your work included in the project:

  1. Fork the project, clone your fork, and configure the remotes:

    # Clones your fork of the repo into the current directory in terminal
git clone https://github.com/<your-username>/<repo-name>.git
# Navigate to the newly cloned directory
cd <repo-name>
# Assigns the original repo to a remote called "upstream"
git remote add upstream https://github.com/<upsteam-owner>/<repo-name>.git

  2. If you cloned a while ago, get the latest changes from upstream:

    git checkout <dev-branch>
git pull upstream <dev-branch>

  3. Create a new topic branch to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>

  4. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your pull request is unlikely be merged into the main project. Use git's interactive rebase feature to tidy up your commits before making them public.

  5. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull [--rebase] upstream <dev-branch>

  6. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  7. Open a Pull Request with a clear title and description.