aboutsummaryrefslogtreecommitdiff
path: root/docs/dev/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/dev/CONTRIBUTING.md')
-rw-r--r--docs/dev/CONTRIBUTING.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/dev/CONTRIBUTING.md b/docs/dev/CONTRIBUTING.md
new file mode 100644
index 000000000..a2efc7afa
--- /dev/null
+++ b/docs/dev/CONTRIBUTING.md
@@ -0,0 +1,18 @@
1The project is in its early stages: contributions are welcome and would be
2**very** helpful, but the project is not _yet_ optimized for contribution.
3Moreover, it is doubly experimental, so there's no guarantee that any work here
4would reach production.
5
6To get an idea of how rust-analyzer works, take a look at the [ARCHITECTURE.md](./ARCHITECTURE.md)
7document.
8
9Useful labels on the issue tracker:
10 * [E-mentor](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-mentor)
11 issues have links to the code in question and tests,
12 * [E-easy](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-easy),
13 [E-medium](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-medium),
14 [E-hard](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-hard),
15 labels are *estimates* for how hard would be to write a fix.
16
17There's no formal PR check list: everything that passes CI (we use [bors](https://bors.tech/)) is valid,
18but it's a good idea to write nice commit messages, test code thoroughly, maintain consistent style, etc.