From 91203699eccf63ee21fee236f493c361c64b5d86 Mon Sep 17 00:00:00 2001 From: Aleksey Kladov Date: Wed, 20 Mar 2019 09:37:51 +0300 Subject: introduce docs dir --- docs/dev/CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 docs/dev/CONTRIBUTING.md (limited to 'docs/dev/CONTRIBUTING.md') 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 @@ +The project is in its early stages: contributions are welcome and would be +**very** helpful, but the project is not _yet_ optimized for contribution. +Moreover, it is doubly experimental, so there's no guarantee that any work here +would reach production. + +To get an idea of how rust-analyzer works, take a look at the [ARCHITECTURE.md](./ARCHITECTURE.md) +document. + +Useful labels on the issue tracker: + * [E-mentor](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-mentor) + issues have links to the code in question and tests, + * [E-easy](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-easy), + [E-medium](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-medium), + [E-hard](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3AE-hard), + labels are *estimates* for how hard would be to write a fix. + +There's no formal PR check list: everything that passes CI (we use [bors](https://bors.tech/)) is valid, +but it's a good idea to write nice commit messages, test code thoroughly, maintain consistent style, etc. -- cgit v1.2.3