Skip to content

Latest commit

 

History

History
58 lines (31 loc) · 3.74 KB

CONTRIBUTING.md

File metadata and controls

58 lines (31 loc) · 3.74 KB
Raw

Hello!

If you're reading this, you'd like to contribute to one of my open source projects! Contributions are welcome and encouraged on this and any other of my projects.

General Resources

  • Github is the primary destination for this project's source code repository, issue tracker, and contribution management (pull requests).
  • Testing infrastructure / CI can be found in the Github Action.
  • Documentation for development is kept in README.md, changelogs in CHANGELOG.

Submitting Pull Requests

Pull requests are a great way to add a new feature for yourself to use, and to help others who might be using this project along the way. Please follow the style guide below for your code submissions, add unit tests if at all possible, and don't forget to adequately test your code functionally before you make the request. I'll get to it as soon as I can, and review it with you if need be.

Filing Bugs

If you come across a bug in this project, your bug reports are welcome! Take a look at the issue tracker first to make sure the bug hasn't already been reported. If you end up filing a duplicate, don't worry - better to have an over-reported bug then one that goes unnoticed!

The best bug reports are short but clear. There's a certain amount of critical information needed in order to successfully solve the problem. Please try to make sure your bug report touches on the following:

  • Context: information on the issue encountered
  • Process: an ordered list of the steps I can take to reproduce the issue
  • Expected result: the result you expect to happen when you follow the above steps
  • Actual result: the thing that happens (that is not supposed to happen) when you follow the above steps
  • Any suggested fixes, stack traces or supporting documentation that would be helpful. If you are running a GUI-based application, screenshots are also good to include.

Requesting Improvements

If you have suggestions regarding how this project can be improved, but are not able to submit a pull request to achieve it yourself, feel free to file an issue with "Suggestion" somewhere in the title. It doesn't have to follow the bullet points for bugs given above, but should include detailed information about your use case, and most importantly why this suggestion would be good for anyone else who would like to use this project.

Style Guide

A few things to remember when contributing code:

  • Commit messages should accurately enough describe the problem.
  • Be sure to adequately comment lengthy contributions.
  • Python code should use four spaces for each indent, instead of a tab.
  • Python code should follow PEP8 whenever feasible. I recommend using flake8.
  • Python code should support Python 3 by default. (If this is a Python 2.x-only repo or branch, disregard)
  • JavaScript code should support JavaScript Standard Style.

Conduct

I try to use all of my projects as an example of what positive and respectful effort can achieve in open source. I invite you to do the same as you contemplate contributing to this project. Feel free to offer constructive criticism when you feel its necessary, but refrain from being unnecessarily harsh, making any sort of personal attack or using inappropriate language. I have zero tolerance for harassment of any kind.

Asking for Help

If you'd like to ask questions about contributing to this project or about the code contained within, feel free! My profile page on GitHub will have links to my Twitter account or my email, I will respond whenever possible.

Thank you!