Sulkta-Coop/agora
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add links to git policy in README and CONTRIBUTING

Browse source 
Additionally, this commit links the README to CONTRIBUTING. I'd love to
get rid of "governance concepts" too. But I'll do that once the
"conceptual spec" has been reviewed.
This commit is contained in:
Emily Martins 2022-05-27 19:49:55 +02:00
parent 183ae4fc01
commit a3d0d95610
No known key found for this signature in database
2 changed files with 7 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTING.md
View file

@ -4,6 +4,8 @@ This document is intended for those whom wish to contribute to Agora, in the for
Before making any form of contribution, it is advised that one familiarises themselves with the [existing documentation](https://liqwid.notion.site/e85c09d2c9a542b19aac8dd3d6caa98b?v=d863219cd6a14082a661c4959cabd6e7). This will enable the contributor to submit better, more informed issues and will potentially aid a developer in writing PRs. Before making any form of contribution, it is advised that one familiarises themselves with the [existing documentation](https://liqwid.notion.site/e85c09d2c9a542b19aac8dd3d6caa98b?v=d863219cd6a14082a661c4959cabd6e7). This will enable the contributor to submit better, more informed issues and will potentially aid a developer in writing PRs.
Please follow the [Git policy](https://liqwid.notion.site/Git-Policy-9a7979b2fd5d4604b6d042b084e7e14f) when contributing to this project.
## Agora core team ## Agora core team
This document will make reference to the _Agora core team_. These are the people who work on Agora professionally and will be responsible for maintaining the project in its open source life. They include: This document will make reference to the _Agora core team_. These are the people who work on Agora professionally and will be responsible for maintaining the project in its open source life. They include:
@ -46,7 +48,7 @@ Agora utilises [Plutarch](https://github.com/plutonomicon/plutarch) and your wor
### Stylistic guidelines ### Stylistic guidelines
All work must comply with the [MLabs style guide](https://github.com/mlabs-haskell/styleguide/). All work must comply with the [MLabs style guide](https://github.com/mlabs-haskell/styleguide/).
### Continuous integration ### Continuous integration

4
README.md
View file

@ -31,6 +31,10 @@ Haddock is deployed on GitHub Pages [here](https://liqwid-labs.github.io/agora/)
If you are a protocol wanting to use Agora, read [Using Agora](https://liqwid.notion.site/Using-Agora-74ceb4a70d024992abd9ff07087013e6). If you are a protocol wanting to use Agora, read [Using Agora](https://liqwid.notion.site/Using-Agora-74ceb4a70d024992abd9ff07087013e6).
## Contributing
Please read [CONTRIBUTING.md](./CONTRIBUTING.md). Additionally, please follow the [Git policy](https://liqwid.notion.site/Git-Policy-9a7979b2fd5d4604b6d042b084e7e14f) when contributing to this project.
## Road-map ## Road-map
### v1 ### v1