Skip to content

Latest commit

 

History

History
75 lines (45 loc) · 3.84 KB

CONTRIBUTING.md

File metadata and controls

75 lines (45 loc) · 3.84 KB
Raw

Help us to help you!

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 wiki documentation.
  • Check existing issues, open and closed, to make sure it hasn't already been suggested

Filing a bug report

If you're having trouble with Machinaris try asking on our Discussions (https://github.com/guydavis/machinaris/discussions) or Discord (https://discord.gg/mX4AtMTt87). Feel free to submit fixes for documentation too, not just bugs!

If all else fails then please raise an Issue to let us know. Be as detailed as possible, and be ready to answer questions when we get back to you. Make sure you include your system setup:

  • OS: [e.g. Ubuntu, Windows, MacOS, Unraid, etc]
  • Docker version number (output of docker info)
  • Machinaris branch: main/test/develop (you're probably on main)
  • Machinaris version number (see bottom of every Machinaris page)

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 fork the project and work off the integration branch.
  • 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 change is expected to do
  • Do include the new API calls by updating the Postman collection

Don't

  • Don't include any separate license information in your change - our repo is Apache licensed
  • Don't try to do too much at once - submit one feature/fix at a time, and be receptive to feedback

Licensing

When you submit code to our libraries, you implicitly and irrevocably agree to adopt the associated licenses. You should be able to find this in the file named LICENSE.

We use the Apache license; which permits Commercial Use, Modification, Distribution and Private use of our code, and therefore also your contributions. It also provides good compatibility with other licenses, and is intended to make re-use of our code as painless as possible for all parties.

You can learn more about the Apache license: https://www.apache.org/licenses/LICENSE-2.0

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.

-- Guy Davis - 2021-06-21