Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.89 KB

CONTRIBUTING.rst

File metadata and controls

44 lines (30 loc) · 1.89 KB
Raw

Contribute to JIRA Time Machine

Thank you for taking time to contribute to JIRA Time Machine!

The following is a set of guidelines for contributing to JIRA Time Machine. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Bug Reports

  1. Use a clear and descriptive title for the issue - it'll be much easier to identify the problem.
  2. Describe the steps to reproduce the problems in as many details as possible.
  3. If possible, provide a code snippet to reproduce the issue.

Feature requests/proposals

  1. Use a clear and descriptive title for the proposal
  2. Provide as detailed description as possible
    • Use case is great to have
  3. There'll be a bit of discussion for the feature. Don't worry, if it is to be accepted, we'd like to support it, so we need to understand it thoroughly.

Pull requests

  1. Start with a bug report or feature request
  2. Use a clear and descriptive title
  3. Provide a description - which issue does it refers to, and what part of the issue is being solved
  4. Be ready for code review :)

Commits

  1. Make sure commits are atomic, and each atomic change is being followed by test.
  2. If the commit solves part of the issue reported, include refs #[Issue number] in a commit message.
  3. If the commit solves whole issue reported, please refer to Closing issues via commit messages for ways to close issues when commits will be merged.

Coding style

  1. All python coding style are being enforced by Pylama and configured in pylama.ini file.
  2. Additional, not always mandatory checks are being performed by QuantifiedCode