File tree Expand file tree Collapse file tree 2 files changed +33
-2
lines changed Expand file tree Collapse file tree 2 files changed +33
-2
lines changed Original file line number Diff line number Diff line change 1+ # Contributing to rust-analyzer
2+
3+ Thank you for your interest in contributing to rust-analyzer! There are many ways to contribute
4+ and we appreciate all of them.
5+
6+ To get a quick overview of the crates and structure of the project take a look at the
7+ [ ./docs/dev] ( ./docs/dev ) folder.
8+
9+ If you have any questions please ask them in the [ rust-analyzer zulip stream] (
10+ https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frust-analyzer ) or if unsure where
11+ to start out when working on a concrete issue drop a comment on the related issue for mentoring
12+ instructions (general discussions are recommended to happen on zulip though).
13+
14+ ## Fixing a bug or improving a feature
15+
16+ Generally it's fine to just work on these kinds of things and put a pull-request out for it. If there
17+ is an issue accompanying it make sure to link it in the pull request description so it can be closed
18+ afterwards or linked for context.
19+
20+ If you want to find something to fix or work on keep a look out for the ` C-bug ` and ` C-enhancement `
21+ labels.
22+
23+ ## Implementing a new feature
24+
25+ It's advised to first open an issue for any kind of new feature so the team can tell upfront whether
26+ the feature is desirable or not before any implementation work happens. We want to minimize the
27+ possibility of someone putting a lot of work into a feature that is then going to waste as we deem
28+ it out of scope (be it due to generally not fitting in with rust-analyzer, or just not having the
29+ maintenance capacity). If there already is a feature issue open but it is not clear whether it is
30+ considered accepted feel free to just drop a comment and ask!
Original file line number Diff line number Diff line change @@ -13,8 +13,9 @@ https://rust-analyzer.github.io/manual.html#installation
1313
1414## Documentation
1515
16- If you want to ** contribute** to rust-analyzer or are just curious about how
17- things work under the hood, check the [ ./docs/dev] ( ./docs/dev ) folder.
16+ If you want to ** contribute** to rust-analyzer check out the [ CONTRIBUTING.md] ( ./CONTRIBUTING.md ) or
17+ if you are just curious about how things work under the hood, check the [ ./docs/dev] ( ./docs/dev )
18+ folder.
1819
1920If you want to ** use** rust-analyzer's language server with your editor of
2021choice, check [ the manual] ( https://rust-analyzer.github.io/manual.html ) folder.
You can’t perform that action at this time.
0 commit comments