3Contributions and issue reports are encouraged and appreciated!
5- [Opening Issues](#opening-issues)
6- [Submitting Changes](#submitting-changes)
7 - [Guidelines for Commit Messages](#guidelines-for-commit-messages)
8 - [Guidelines for Pull Requests](#guidelines-for-pull-requests)
9 - [Code Quality](#code-quality)
10 - [Documentation](#documentation)
14Before opening an issue, please check whether your issue has already been reported. Assuming it has not:
16* Describe the issue you're encountering or the suggestion you're making
17* Include any relevant steps to reproduce or code samples you can. It's always easier for us to debug if we have something that demonstrates the error.
18* Let us know what version of this project you were using. If you're using a github checkout, provide the git hash.
22Most pull requests should target the `develop` branch. `master` is the release branch. `develop` is periodically merged into master after a period of testing.
24### Guidelines for Commit Messages
27The summary line of your commit message should summarize the changes being made. Commit messages should be written in the imperative mood and should describe what happens when the commit is applied. If your commit modifies one of the in-tree haskell packages (found in `./lib`), please prefix your commit summary with the name of the package being modified.
29One way to think about it is that your commit message should be able to complete the sentence:
30"When applied, this commit will..."
32##### Note on bumping dependencies
33Commits that update a dependency should include some information about why the dependency was updated in the commit message.
36For breaking changes, new features, refactors, or other major changes, the body of the commit message should describe the motivation behind the change in greater detail and may include references to the issue tracker. The body shouldn't repeat code/comments from the diff.
38### Guidelines for Pull Requests
40Wherever possible, pull requests should add a single feature or fix a single bug. Pull requests should not bundle several unrelated changes.
46Your pull request should add no new warnings to the project. It should also generally not disable any warnings.
50Make sure the project builds and that the tests pass! This will generally also be checked by CI before merge, but trying it yourself first means you'll catch problems earlier and your contribution can be merged that much sooner!
52You can run the tests like this:
54$(nix-build -A selftest --no-out-link)
57To test that your changes build across platforms, you can also try to build release.nix, like this:
62Note, however, that to build release.nix you must accept the android license agreement and your machine must be configured to build both ios and android executables (usually via remote builders).
68We're always striving to improve documentation. Please include [haddock](https://haskell-haddock.readthedocs.io/en/latest/index.html) documentation for any added code, and update the documentation for any code you modify.
70#### In the [Changelog](ChangeLog.md)
71Add an entry to the changelog when your PR:
74* Includes a breaking change
75* Makes any other change that will impact users
77#### In the [Readme](README.md)
78The readme is the first place a lot of people look for information about the repository. Update any parts of the readme that are affected by your PR.
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list