Due to general and personal experience, I feel compelled to preface this with a short, pointed statement.
Developers, maintainers, and others usually contribute to open source software in spare time from full lives. We owe you nothing. Check your attitude and entitlement at the virtual door; they won't be tolerated.
For a longer, softer version of that message, check out Brett Cannon's Setting expectations for open source participation talk (video, text).
See the Code of Conduct for behavioral expectations.
- Post in the Development category on the Discourse forum.
- Browse and comment on issues or pull requests.
- Open an issue with a bug report or feature request.
- See current projects.
- Contact me by email at mail@thebigmunch.me.
Bug reports and feature requests can be submitted to the Issue Tracker. For discussion and support, use the Discourse forum.
Some general guidelines to follow:
- Use an appropriate, descriptive title.
- Provide as many details as possible.
- Don't piggy-back; keep separate topics in separate issues.
An issue should be opened for discussion prior to making a Pull Request for most changes.
Keep your code consistent with the rest of the project.
- Tabs should be used for indentation of code.
- Don't use line continuation that aligns with opening delimiter.
- Readability and understandibility are more important than arbitrary rules.
Pull Requests should originate from a feature branch in your fork, not from the main branch.
Commit messages should be written in a
well-formed, consistent manner.
If the commit is linked to an issue, add a reference to that issue at the end of the commit message
in the form of [#00].
See the commit log for acceptable examples.
Each commit should encompass the smallest logical changeset. E.g. changing two unrelated things in the same file would be two commits rather than one commit of "Change filename".
If you need to make a change to your Pull Request, you should amend or rebase to change your previous commit(s) then force push to the feature branch in your fork.
For anything else, contact the author by e-mail at mail@thebigmunch.me.