Skip to content

Commit a5adbe8

Browse files
authored
docs: add progressive "Task Lists" sections to CONTRIBUTING.md (#22537)
1 parent df9cf27 commit a5adbe8

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,43 @@
1+
## How to help and contribute to the V project
2+
3+
The tasks in the lists below are ordered in terms of easiness/time/nerves
4+
investment.
5+
6+
### Starting tasks
7+
8+
1. Read the [language documentation](https://docs.vlang.io/introduction.html) and [standard module documentation](https://modules.vlang.io/).
9+
10+
2. Fix doc errors and places you found unclear, and make [PRs](https://github.com/vlang/v/pulls) about it.
11+
12+
3. Make V programs, in the areas that you are interested in, or help others make
13+
V programs. If the programs/libraries are public, post them to the channel
14+
`#showcase-discussion` on [Discord](https://discord.gg/vlang) and/or to
15+
[awesome-v](https://github.com/vlang/awesome-v). You can also answer other
16+
people's questions in Discord channels `#help` or `#v-chat`, or in
17+
[github's discussions page](https://github.com/vlang/v/discussions).
18+
19+
4. Read the new issues in the tracker.
20+
21+
5. Try to reproduce them on your system, and comment in the issues, with the
22+
results.
23+
24+
6. Read the PRs, try to spot errors in them, and comment about them.
25+
26+
### Medium tasks (after gathering experience with 1..6)
27+
28+
7. Make PRs, with bug fixes to existing issues (found doing 1..6).
29+
30+
8. Suggest new features, tools, or modifications to the existing ones here,
31+
based on the experience, that you gathered doing 1..7.
32+
33+
9. Make PRs with implementations of your suggestions, or based on other people's
34+
suggestions, based on 1..7 and the feedback from 8.
35+
36+
### Advanced tasks (after doing 1..9 for a while)
37+
38+
10. Work on [V RFCs](https://github.com/vlang/rfcs/) (submitting new ones,
39+
providing feedback to existing ones, implementing them).
40+
141
## Code Structure
242

343
I tried to make the code of the compiler and vlib as simple and readable as

0 commit comments

Comments
 (0)