Skip to content
This repository has been archived by the owner on Sep 1, 2022. It is now read-only.

Latest commit

 

History

History
45 lines (29 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 2.45 KB

Contribution Guidelines

Thank you for your interest in contributing to Erin Hunter Book Chooser! Before you contribute please read the following guidelines that will help to make to contribution process a success! Please remember that all contributions must follow the Code of Conduct.

All code is written in Python 3.5-3.6.

Pull Request and Issue Templates can be found here:

Types of Contributions

You can contribute to Bars in the following ways:

  • Update documentation
  • Fix bug fixes
  • Add new features
  • Submitting issues

Submission Process (bug fix or new feature)

To make the contribution process a success please follow these simple steps to get started:

  1. Fork this repo
  2. Create a new branch for each correction in your fork (make sure they are logically grouped)
  3. Submit a pull request to the master branch with your change. PR template can be found here.
  4. The DFD Team will decide on a course of action for your contribution.

Submission Process (issue)

To make the issue process a success please follow these simple steps to get started:

  1. Go to the issues page for this repo.
  2. Check to see if your issue has already been posted.
  3. Click the green New Issue button.
  4. Create issue following the issue template that can be found here.
  5. The DFD Team will decide on a course of action for your contribution.

Tests for Contributing

Erin Hunter Book Chooser (and all DFD projects) uses Travis-CI for its testing. When you submit a pull request Travis-CI will automatically check to see if your build complies and will run correctly on our users computers.

FINE PRINT: By submitting your code you agree that you have the right to that code (you are the owner of the code & changes) and that your contributions are licensed under the GNU General Public License v3.0.