Skip to content

Latest commit

 

History

History
112 lines (68 loc) · 5.7 KB

CONTRIBUTING.md

File metadata and controls

112 lines (68 loc) · 5.7 KB

Contributing to StateForward

First off, thank you for considering contributing to StateForward! It's people like you that make StateForward such a great tool.

Code of Conduct

This project and everyone participating in it is governed by the StateForward Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before submitting a bug report, please check that it has not already been reported by searching on GitHub under Issues.

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

How Do I Submit a Good Bug Report?

Bugs are tracked as GitHub issues. Create an issue on our repository and use the provided bug report template as a guide.

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.
  • 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.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.

Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue on the repository and provide the necessary details:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as much detail as possible.
  • Provide specific examples to illustrate the steps.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of StateForward which the suggestion is related to.

Your First Code Contribution

Unsure where to begin contributing to StateForward? You can start by looking through these good first issue issues:

  • Good first issue - issues which should only require a few lines of code, and a test or two.

Pull Requests

The process described here has several goals:

  • Maintain StateForward's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible StateForward
  • Enable a sustainable system for StateForward's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. Follow all instructions in the template.
  2. Follow the styleguides.
  3. After you submit your pull request, verify that all status checks are passing.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally after the first line.
  • When only changing documentation, include [docs] in the commit title.

Python Styleguide

All Python code must adhere to PEP 8, the Python style guide.

Documentation Styleguide

  • Use MkDocs for markup and formatting.
  • Use Google style docstrings to document the code.

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

Label names are self-explanatory. Descriptions provide additional insight into what they represent.

Type of Issue and Issue State

  • bug: Indicates an issue with the project.
  • enhancement: New feature or request.
  • good first issue: Good for newcomers.

Type of Pull Request

  • work in progress: Pull requests which are still being worked on, more changes will follow.
  • needs review: Pull requests which need code review, and approval from maintainers.
  • under discussion: Pull requests which are being discussed by maintainers, decisions pending.

Remember that contributions to this repository are accepted under the latest MIT Licence and all content should be compatible with this licence.

Thank you for being a part of the community! 🎉