Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (39 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

59 lines (39 loc) · 2.76 KB

Contributing to FailSafe

First off, thanks for taking the time to contribute!

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions.

Table of Contents

I Have a Question

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

I Want To Contribute

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Open a new issue with the label enhancement.
  • Explain why this enhancement would be useful to most FailSafe users.

Your First Code Contribution

  1. Fork the repo on GitHub.
  2. Clone the project to your own machine.
  3. Create a new Branch.
  4. Commit changes to your own branch.
  5. Push your work back to your fork.
  6. Submit a Pull Request so that we can review your changes.

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Styleguides

Code Style

  • We use flake8 for linting.
  • We use pytest for testing. Please ensure all tests pass before submitting.
  • Please include docstrings for new functions/classes (Google Style).

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