Selaa lähdekoodia

readme: Update contribution section

armaniferrante 4 vuotta sitten
vanhempi
sitoutus
75ee90e366
1 muutettua tiedostoa jossa 23 lisäystä ja 2 poistoa
  1. 23 2
      README.md

+ 23 - 2
README.md

@@ -143,12 +143,33 @@ state assocated with each user in individual `#[account]` structs.
 For more, see the [examples](https://github.com/project-serum/anchor/tree/master/examples)
 directory.
 
+## Contribution
+
+Thank you for your interest in contributing to Anchor! All contributions are welcome no
+matter how big or small. This includes includes (but is not limited to) filing issues,
+adding documentation, fixing bugs, creating examples, and implementing features.
+
+If you'd like to contribute, please claim an issue by commenting, forking, and
+opening a pull request, even if empty. This allows the maintainers to track who
+is working on what issue as to not overlap work. If you're looking to get started,
+check out [good first issues](https://github.com/project-serum/anchor/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
+or issues where [help is wanted](https://github.com/project-serum/anchor/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).
+For simple documentation changes, feel free to just open a pull request.
+
+If you're considering larger changes or self motivated features, please file an issue
+and engage with the maintainers in [Discord](https://discord.com/channels/739225212658122886).
+
+When contributing, please make sure your code adheres to some basic coding guidlines:
+
+* Code must be formatted with the configured formatters (e.g. rustfmt and prettier).
+* Comments should be 80 chars and written with proper grammar and punctuation.
+* Commit messages should be prefixed with the package(s) they modify. Changes affecting multiple
+  packages should list all packages. In rare cases, changes may omit the package name prefix.
+
 ## License
 
 Anchor is licensed under [Apache 2.0](./LICENSE).
 
-## Contribution
-
 Unless you explicitly state otherwise, any contribution intentionally submitted
 for inclusion in Anchor by you, as defined in the Apache-2.0 license, shall be
 licensed as above, without any additional terms or conditions.