From bdf8f064a29381ae9606d662b78b18880b9cb273 Mon Sep 17 00:00:00 2001 From: Yamen Merhi Date: Thu, 3 Oct 2024 11:31:38 +0300 Subject: [PATCH 1/3] Add contribute section in README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index aa4d42795..480fce86d 100644 --- a/README.md +++ b/README.md @@ -173,6 +173,10 @@ The following audits and formal verification were conducted. All high-level issu - MiloTruck, 2023-11-31, Final Result: [MiloTruck_audit_2023_11_31.pdf](./audits/MiloTruck_audit_2023_11_31.pdf) - MiloTruck, 2024-01-24, Final Result: [MiloTruck_audit_2024_01_24.pdf](./audits/MiloTruck_audit_2024_01_24.pdf) +## Contribute + +The implementation contracts of the [LSPs](https://github.com/lukso-network/LIPs) exist thanks to their contributors. There are many ways you can participate and help build high quality software. Check out the [contribution guide](./CONTRIBUTING.md)! + ## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): From ee11a93c086948c0782e3b0d5f336d7cd7a040f3 Mon Sep 17 00:00:00 2001 From: Yamen Merhi Date: Thu, 3 Oct 2024 11:33:09 +0300 Subject: [PATCH 2/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8a0b6f0d7..cba51ce4b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,8 @@ Since the `@lukso/lsp-smart-contracts` is an Open Source project, we welcome con - report bug and issues. - introduce new features or bug fixes. +Any non-trivial code contribution must be first discussed with the maintainers in an issue. Only very minor changes are accepted without prior discussion. + ## **Clone project** Our project uses submodules, we recommend you to clone our repository using the following command: From 325bd545d486824ba1ffbca3d9ad7dcc5d12892c Mon Sep 17 00:00:00 2001 From: Yamen Merhi Date: Thu, 10 Oct 2024 10:50:36 +0300 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Jean Cvllr <31145285+CJ42@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cba51ce4b..2806c9f43 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ Since the `@lukso/lsp-smart-contracts` is an Open Source project, we welcome con - report bug and issues. - introduce new features or bug fixes. -Any non-trivial code contribution must be first discussed with the maintainers in an issue. Only very minor changes are accepted without prior discussion. +Any non-trivial code contribution **must be first discussed with the maintainers and the developer community in an [issue](https://github.com/lukso-network/lsp-smart-contracts/issues/new/choose)**. Only very minor changes are accepted without prior discussion. ## **Clone project** diff --git a/README.md b/README.md index 480fce86d..a8c138b5f 100644 --- a/README.md +++ b/README.md @@ -175,7 +175,7 @@ The following audits and formal verification were conducted. All high-level issu ## Contribute -The implementation contracts of the [LSPs](https://github.com/lukso-network/LIPs) exist thanks to their contributors. There are many ways you can participate and help build high quality software. Check out the [contribution guide](./CONTRIBUTING.md)! +The implementation contracts of the [LSPs](https://github.com/lukso-network/LIPs) exist thanks to their contributors. There are many ways you can participate and help build high quality software. Check out the [contribution guidelines](./CONTRIBUTING.md)! ## Contributors ✨