Contributing¶

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it’s:

Reporting a bug
Proposing new features
Submitting new code
Writing documentation

Reporting Bugs¶

To report bugs, please open an issue on Github clearly stating the observed (buggy) behavior (screenshots are encouraged), the desired behavior, which operating system and compiler you’re using (including version), and any additional information that might help us fix the bug. If possible, please provide a minimum example that reproduces the bug.

Fixing Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation¶

dishtiny could always use more documentation, whether as part of the official dishtiny docs, in docstrings, or even on the web in blog posts, articles, and such.

Requesting features¶

We welcome suggestions for how to make this project better! To give us your ideas, open an issue on Github.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/mmore500/dishtiny/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated.

Please see the Code of Conduct for community guidelines for positive behavior.