Skip to content

Commit 8797851

Browse files
authored
Update CONTRIBUTING.md
1 parent c5e4237 commit 8797851

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Please make sure to check out our [Code of Conduct](CODE_OF_CONDUCT.md) and make
66

77
## Ways to contribute
88

9-
- Writing docs for the manual (Check for issues that are marked with a `manual` and `help wanted` tag)
9+
- Writing docs for the manual (Check for issues that are marked with a [`manual`](https://github.com/reason-association/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"manual") and [`help wanted`](https://github.com/reason-association/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"help+wanted") tag)
1010
- Joining in discussions on our [issue tracker](https://github.com/reason-association/rescript-lang.org/issues)
1111
- Give feedback for improvements (incomplete / missing docs, bad wording,
1212
search user experience / design, etc.)
@@ -24,26 +24,32 @@ If you can't find any relevant issues, feel free to create a new one to start a
2424

2525
The project follows very specific goals and tries to deliver the highest value with the least amount of resources. Please help us focus on the tasks at hand and don't submit any code / bigger refactorings without any proper discussion on the issue tracker. Otherwise your PR might not be accepted!
2626

27-
If you need inspiration on what to work on, you can check out issues tagged with [`good first issue`](https://github.com/reason-association/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"good+first+issue").
27+
If you need inspiration on what to work on, you can check out issues tagged with [`good first issue`](https://github.com/reason-association/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"good+first+issue") or [`help wanted`](https://github.com/reason-association/rescript-lang.org/issues?q=is%3Aissue+is%3Aopen+label%3A"help+wanted").
2828

2929
### Discuss an issue
3030

3131
We really appreciate all input from users, community members and potential contributors. Please make sure to consider the other person's opinion and don't assume any common knowledge.
3232

3333
**Most importantly: Keep it professional and be nice to eachother**
3434

35-
There might be situations where others don't understand a proposed feature or architectural change. That's fine, discussions are always welcome! Communicate in clear actionables, make your plans clear and always to stick to the original topic.
35+
There might be situations where others don't understand a proposed feature or have different opinions on certain writing styles. That's fine, discussions are always welcome! Communicate in clear actionables, make your plans clear and always to stick to the original topic.
3636

3737
If other contributors disagree with certain proposals and don't change their mind after longer discussions, please don't get discouraged when an issue gets closed / postponed. Everyone tries their best to make the platform better, and to look at it in another perspective: Closed issues are also a highly valuable resource for others to understand technical decisions later on.
3838

39+
### Communicate your Time Commitment
40+
41+
Open Source development can be a challenge to coordinate, so please make sure to block enough time to work on your tasks and show commitment when taking on some work. Let other contributors know if your time schedule changes significantly, and also let others know if you can't finish a task.
42+
43+
We value your voluntary work, and of course it's fine to step back from a ticket for any reasons (we can also help you if you are getting stuck). Please talk to us in any case, otherwise we might re-assign the ticket to other contributors.
44+
3945
### Communication Channels
4046

4147
- [Issue Tracker](https://github.com/reason-association/rescript-lang.org/issues)
4248
- [ReScript Discourse (General / mostly unrelated discussions)](http://forum.rescript-lang.org)
4349

44-
## Working on the rescript-lang.org codebase
50+
## Working on the rescript-lang.org
4551

46-
We try to keep our contribution guidelines to a minimum. Please keep following rules in mind whenever writing code.
52+
We try to keep our contribution guidelines to a minimum. Please keep following rules in mind whenever writing code or technical documentation.
4753

4854
### Keep it simple
4955

@@ -57,7 +63,7 @@ The rescript-lang.org project aims to be the best documentation experience for o
5763

5864
Always check if there are any designs for certain UI components and think about how to get the most out for the users. Jumpy UI, slow loading, big assets and bad accessibility is not what we stand for.
5965

60-
### Doc Writing Notes
66+
### Technical Writing (Documentation)
6167

6268
- Think and write in a JS friendly mindset when explaining concepts / showing examples.
6369
- No `foo` examples if somewhat possible. Try to establish practical context in your show case examples.
@@ -80,3 +86,4 @@ Most of the stuff we want to build can be built as components with Tailwind clas
8086
- Always run the page locally and verify your changes (especially when working on code examples)
8187
- When writing markdown with code examples, always run `yarn test` to prevent broken code
8288
- Feel free to open `Draft PRs` when you are working on bigger features (good for visibility and asking for feedback)
89+
- Improve code based on last feedback until the code is ready to be merged

0 commit comments

Comments
 (0)