From 8cfde80179f4cd6f34a1202f37a8fd447a25f50b Mon Sep 17 00:00:00 2001 From: Seungheon Oh Date: Wed, 31 Aug 2022 18:02:12 -0500 Subject: [PATCH 1/2] add link to new standards in notion --- CONTRIBUTING.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 21d35f8..5480066 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,10 +46,6 @@ Contributors should expect that if their work is insufficiently documented (eith 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 For your PR to be merged it must pass three automated checks: @@ -64,6 +60,12 @@ Our custom `fourmolu` rules may be found in the [base of the repository](./fourm 2. Running `make lint` from the included `Makefile` and applying any recommendations. 3. Ensuring that `cabal build` terminates successfully on your machine in the provided Nix environment. +## Standards + +Agora follows a strict standards to increase consistency, to minimize +legacy impacts, to use proper automated means, and more. The standard document +can be discovered in [here](https://liqwid.notion.site/Coding-Standards-cd3c430e6e444fa292ecc3c57b7d95eb). + ## Documentation It is worth noting that the codebase is not the only aspect of the project that it is worth contributing to. In the event that one finds the docs unsatisfactory, the Agora team would welcome receiving any issues describing your reservations or PRs pertaining to documentation. From aed289f456053490cbb5403ca2c023bb71a16d22 Mon Sep 17 00:00:00 2001 From: SeungheonOh Date: Wed, 31 Aug 2022 18:18:32 -0500 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5480066..4c58ac0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,9 +62,9 @@ Our custom `fourmolu` rules may be found in the [base of the repository](./fourm ## Standards -Agora follows a strict standards to increase consistency, to minimize -legacy impacts, to use proper automated means, and more. The standard document -can be discovered in [here](https://liqwid.notion.site/Coding-Standards-cd3c430e6e444fa292ecc3c57b7d95eb). +Agora follows strict standards to increase consistency, to minimize +the impact of legacy, to properly use automated tools, and more. The standards document +can be found [here](https://liqwid.notion.site/Coding-Standards-cd3c430e6e444fa292ecc3c57b7d95eb). ## Documentation