Skip to content

Latest commit

 

History

History
68 lines (41 loc) · 3.37 KB

CONTRIBUTING.md

File metadata and controls

68 lines (41 loc) · 3.37 KB
Raw

Help us to help you!

Adopted from Python template CONTRIBUTING.md

Thank you for taking the time to contribute!

Suggesting a feature

We can't think of everything. If you've got a good idea for a feature, then please let us know!

Feature suggestions are embraced, but will often be filed for a rainy day. If you require a feature urgently it's best to write it yourself. Don't forget to share ;)

When suggesting a feature, make sure to:

  • Check the code on GitHub to make sure it's not already hiding in an unreleased version ;)
  • Considered if it's necessary in the library, or is an advanced technique that could be separately explained in an example
  • Check existing issues, open and closed, to make sure it hasn't already been suggested

Submitting a pull request

If you've decided to fix a bug, even something as small as a single-letter typo then great! Anything that improves the code/documentation for all future users is warmly welcomed.

If you decide to work on a requested feature it's best to let us (and everyone else) know what you're working on to avoid any duplication of effort. You can do this by replying to the original Issue for the request.

If you want to contribute an example; go for it! We might not always be able to accept your code, but there's a lot to be learned from trying anyway and if you're new to GitHub we're willing to guide you on that journey.

When contributing a new example or making a change to a library please keep your code style consistent with ours. We try to stick to the pep8 guidelines for Python (https://www.python.org/dev/peps/pep-0008/).

Do

  • Do use pep8 style guidelines
  • Do comment your code where necessary
  • Do submit only a single example/feature per pull-request
  • Do include a description of what your example is expected to do
  • Do add details of your example to examples/README.md if it exists

Don't

  • Don't include any license information in your examples- this repository is MIT licensed
  • Don't try to do too much at once- submit one or two examples at a time, and be receptive to feedback
  • Don't submit multiple variations of the same example, demonstrate one thing concisely

If you're submitting an example

Try to do one thing, and do it concisely. Keep it simple. Don't mix too many ideas.

The ideal example should:

  • demonstrate one idea, technique or API as concisely as possible in a single Python script
  • just work when you run it. Although sometimes configuration is necessary
  • be well commented and attempt to teach the user how and why it works
  • document any required configuration, and how to install API keys, dependencies, etc

Submitting your code

Once you're ready to share your contribution with us you should submit it as a Pull Request.

  • Be ready to receive and embrace constructive feedback.
  • Be prepared for rejection; we can't always accept contributions. If you're unsure, ask first!

Thank you!

If you have any questions, concerns or comments about these guidelines, please get in touch. You can do this by raising an issue against our template repository here: https://github.com/pimoroni/template-python

Above all else, we hope you enjoy yourself, learn things and make and share great contributions.