Many thanks for your interest in contributing to the Contour terminal emulator.
Any kind of contribution is welcome, let it be coding (feature, bugfixes), documentation, or just bug management / community management.
If you would like to contribute but do not know how, we welcome you to join our Discord. You can also see some live development on Twitch.
- Please keep in mind, this project is still in its very early stages (started Augost 2019) and thus under very active development. It's not perfect nor bug-free yet.
- Please fork the main repository at github.com/contour-terminal/contour then git clone your repository into your preferred location.
- Always work on a branch based off the master branch, if it is a feature or a bugfix.
- Please have a look at the coding style guidelines.
- When creating a pull request, please see if you can keep the commits as atomic as possible. That is, a single reasonabily sized feature or functionality should be committed as one single commit. If you can branch out a some functionality, let it be a more generalized API or refactor of something that can stand on their own, then those deserve their own commits.
- Every new feature should ideally be unit-testable, this isn't always possible or easy for pure GUI tasks, but the rest should ideally get one. The plus-side of this story is, that one can test their own code right with the new test case.
- Bug fixes should ideally also result into an added or tweaked or fixed test case, if possible.