2019-05-31 16:27:42 +03:00
|
|
|
# Contributing
|
|
|
|
|
|
|
|
Issues (bugs, feature requests or otherwise feedback) may be reported in
|
2019-08-28 16:05:53 +03:00
|
|
|
[the GitHub issue tracker for this project][issues]. Pull requests are also
|
2019-05-31 16:27:42 +03:00
|
|
|
welcome.
|
|
|
|
|
|
|
|
When contributing to this repository, please first discuss the change you
|
|
|
|
wish to make via an issue, unless it's entirely trivial (typo fixes, etc.).
|
|
|
|
If there is already an issue that describes the change you have in mind,
|
|
|
|
comment on it indicating that you're going to work on that. This way we can
|
|
|
|
avoid the situation when several people work on the same thing.
|
|
|
|
|
|
|
|
Please make sure that all non-trivial changes are described in commit
|
|
|
|
messages and PR descriptions.
|
|
|
|
|
|
|
|
## What to hack on?
|
|
|
|
|
2019-07-13 22:41:42 +03:00
|
|
|
* [Fixing bugs][bugs]. This is the main focus right now.
|
2019-05-31 16:27:42 +03:00
|
|
|
|
|
|
|
### Testing
|
|
|
|
|
|
|
|
Testing has been taken good care of and now it amounts to just adding
|
|
|
|
examples under `data/examples`. Each example is a pair of files:
|
|
|
|
`<example-name>.hs` for input and `<example-name>-out.hs` for corresponding
|
|
|
|
expected output.
|
|
|
|
|
|
|
|
Testing is performed as following:
|
|
|
|
|
|
|
|
* Given snippet of source code is parsed and pretty-printed.
|
|
|
|
* The result of printing is parsed back again and the AST is compared to the
|
|
|
|
AST obtained from the original file. They should match.
|
|
|
|
* The output of printer is checked against the expected output.
|
|
|
|
* Idempotency property is verified: formatting already formatted code
|
|
|
|
results in exactly the same output.
|
|
|
|
|
|
|
|
Examples can be organized in sub-directories, see the existing ones for
|
|
|
|
inspiration.
|
|
|
|
|
2019-08-28 16:05:53 +03:00
|
|
|
Please note that we try to keep individual files at most 25 lines long
|
|
|
|
because otherwise it's hard to figure out want went wrong when a test fails.
|
|
|
|
|
2019-07-13 22:41:42 +03:00
|
|
|
## CI
|
|
|
|
|
|
|
|
We use Circle CI. Some outside contributors may have problems, as in, CI
|
|
|
|
won't run for PRs opened from forks with “unauthorized” errors. In that case
|
|
|
|
the best we can do is to add you as a contributor or to restart your build
|
|
|
|
manually.
|
|
|
|
|
|
|
|
If you have been added as a contributor but the builds still do not start,
|
|
|
|
try clicking
|
|
|
|
|
|
|
|
```
|
|
|
|
User settings -> Account integrations -> Refresh permissions
|
|
|
|
```
|
|
|
|
|
|
|
|
in Circle CI app.
|
|
|
|
|
2019-08-27 18:41:12 +03:00
|
|
|
## Formatting
|
|
|
|
|
|
|
|
Use `format.sh` script to format Ormolu with current version of Ormolu. If
|
|
|
|
Ormolu is not formatted like this, the CI will fail.
|
|
|
|
|
2019-08-28 16:05:53 +03:00
|
|
|
[issues]: https://github.com/tweag/ormolu/issues
|
2019-05-31 16:27:42 +03:00
|
|
|
[bugs]: https://github.com/tweag/ormolu/issues?q=is%3Aissue+is%3Aopen+label%3Abug
|