diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fee2cdf..21d35f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,9 @@ This document is intended for those whom wish to contribute to Agora, in the form of submitting issues or writing pull requests (PR). Thank you! The Agora core team is delighted to have community members contribute to our project. -Before making any form of contribution, it is advised that one familiarises themselves with the [existing documentation](./docs). 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 @@ -46,7 +48,7 @@ Agora utilises [Plutarch](https://github.com/plutonomicon/plutarch) and your wor ### 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 diff --git a/README.md b/README.md index 28d4d7c..b412631 100644 --- a/README.md +++ b/README.md @@ -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). +## 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 ### v1