Sulkta-OSS/agora
3
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

Pointed contributing towards plutarch and mlabs style guide

Browse source
This commit is contained in:
Jack Hodgkinson 2022-04-06 10:39:59 +01:00
parent 049b2ce523
commit a2564e9dab
1 changed files with 18 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

9
CONTRIBUTING.md
View file

@ -40,9 +40,18 @@ Before submitting a PR, please write an issue pertaining to the problem that you
Contributors should expect that if their work is insufficiently documented (either on GitHub or within the codebase) that their PR will not be reviewed by core Agora team members. Contributors should expect that an Agora maintainer may offer constructive feedback and request changes to be made, prior to the PR being incorporated into the project. Contributors should expect that if their work is insufficiently documented (either on GitHub or within the codebase) that their PR will not be reviewed by core Agora team members. Contributors should expect that an Agora maintainer may offer constructive feedback and request changes to be made, prior to the PR being incorporated into the project.
### Technical requirements
Agora utilises [Plutarch](https://github.com/plutonomicon/plutarch) and your work must be written with Plutarch, when appropriate. Plutarch can prove _complicated_ but the documentation is extensive. We would encourage you to dive deeply into the documentation, whilst stating that Plutarch's [Tricks.md](https://github.com/Plutonomicon/plutarch/blob/master/docs/Tricks.md) could prove particularly helpful.
### Stylistic guidelines
All work must comply with the [MLabs style guide](https://github.com/mlabs-haskell/styleguide/).
### Continuous integration ### Continuous integration
For your PR to be merged it must pass three automated checks: For your PR to be merged it must pass three automated checks:
1. A [`fourmolu`](https://github.com/fourmolu/fourmolu) formatting check. 1. A [`fourmolu`](https://github.com/fourmolu/fourmolu) formatting check.
2. A [`hlint`](https://github.com/ndmitchell/hlint) linting check. 2. A [`hlint`](https://github.com/ndmitchell/hlint) linting check.
3. A Cabal build check. 3. A Cabal build check.