Skip to content

Commit 158043b

Browse files
authored
Update CONTRIBUTING.md
1 parent 7c9ed21 commit 158043b

File tree

1 file changed

+25
-54
lines changed

1 file changed

+25
-54
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 54 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 Belt
9+
- Writing docs for the manual (Check for issues that are marked with a `manual` and `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.)
@@ -16,43 +16,25 @@ Please make sure to check out our [Code of Conduct](CODE_OF_CONDUCT.md) and make
1616

1717
### Find an issue
1818

19-
Before you start any work or submit any PRs, make sure to check our [issue
20-
tracker](https://github.com/reason-association/rescript-lang.org/issues) for any
21-
issues or discussions on the topic.
19+
Before you start any work or submit any PRs, make sure to check our [issue tracker](https://github.com/reason-association/rescript-lang.org/issues) for any issues or discussions on the topic.
2220

23-
If you can't find any relevant issues, feel free to create a new one to start a
24-
discussion. We usually assign issues to a responsible person to prevent confusion and duplicate work, so always double check if an issue is currently being worked on, or talk
25-
to the current assignee to take over the task.
21+
If you can't find any relevant issues, feel free to create a new one to start a discussion. We usually assign issues to a responsible person to prevent confusion and duplicate work, so always double check if an issue is currently being worked on, or talk to the current assignee to take over the task.
2622

2723
**Always make sure to get feedback from the core maintainers before starting any work**
2824

29-
The project follows very specific goals and tries to deliver the highest value
30-
with the least amount of resources. Please help us focus on the tasks at hand
31-
and don't submit any code / bigger refactorings without any proper discussion
32-
on the issue tracker. Otherwise your PR might not be accepted!
25+
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!
3326

34-
If you need inspiration on what to work on, you can check out issues tagged
35-
with [`good first
36-
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").
3728

3829
### Discuss an issue
3930

40-
We really appreciate all input from users, community members and potential
41-
contributors. Please make sure to consider the other person's opinion and
42-
don't assume any common knowledge.
31+
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.
4332

4433
**Most importantly: Keep it professional and be nice to eachother**
4534

46-
There might be situations where others don't understand a proposed feature or
47-
architectural change. That's fine, discussions are always welcome! Communicate
48-
in clear actionables, make your plans clear and always to stick to the original
49-
topic.
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.
5036

51-
If other contributors disagree with certain proposals and don't change their
52-
mind after longer discussions, please don't get discouraged when an issue gets
53-
closed / postponed. Everyone tries their best to make the platform better, and
54-
to look at it in another perspective: Closed issues are also a highly valuable
55-
resource for others to understand technical decisions later on.
37+
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.
5638

5739
### Communication Channels
5840

@@ -61,51 +43,40 @@ resource for others to understand technical decisions later on.
6143

6244
## Working on the rescript-lang.org codebase
6345

64-
We try to keep our contribution guidelines to a minimum. Please keep following
65-
rules in mind whenever writing code.
46+
We try to keep our contribution guidelines to a minimum. Please keep following rules in mind whenever writing code.
6647

6748
### Keep it simple
6849

69-
The less code we write, the better. If there's a way to do rendering on the
70-
server, or enhance existing markdown files, we prefer that over client-side
71-
rendering and external loading.
50+
The less code we write, the better. If there's a way to do rendering on the server, or enhance existing markdown files, we prefer that over client-side rendering and external loading.
7251

73-
We also try to keep our third-party dependencies to a minimum. We use specific
74-
high value frameworks to make things work (`unified`, `remark`, `mdx`,
75-
`bs-platform`, etc). Please try to keep a small JS footprint, especially for
76-
client side code (to keep the bundle size small).
52+
We also try to keep our third-party dependencies to a minimum. We use specific frameworks to make things work (`unified`, `remark`, `mdx`, `bs-platform`, etc). Please try to keep a small JS footprint, especially for client side code (to keep the bundle size small).
7753

7854
### Think about the target audience & UX
7955

80-
The rescript-lang.org project aims to be the best documentation experience for
81-
our ReScript users.
56+
The rescript-lang.org project aims to be the best documentation experience for our ReScript users.
8257

83-
Always check if there are any designs for certain UI components and think
84-
about how to get the most out for the users. Jumpy UI, slow
85-
loading, big assets and bad accessibility is not what we stand for.
58+
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.
8659

87-
### Comply to our CSS ways
60+
### Doc Writing Notes
8861

89-
We use [TailwindCSS](https://tailwindcss.com) for our component styling. Check
90-
out the [tailwind.config.js](tailwind.config.js) file for configured tailwind
91-
features, colors, border-radius values etc.. If you are not familiar with
92-
Tailwind, check out existing components for inspiration.
62+
- Think and write in a JS friendly mindset when explaining concepts / showing examples.
63+
- No `foo` examples if somewhat possible. Try to establish practical context in your show case examples.
64+
- No references to `OCaml`. ReScript is its own language, and we don't rely on external resources of our host language.
65+
- If possible, no references to `Reason` examples / external resources. Our goal is to migrate everything to ReScript syntax.
9366

94-
We sometimes also need to fall back to common css (with tailwind `@apply`
95-
directives to enforce our style system). You can find the CSS main entrypoint
96-
in [styles/main.css](styles/main.css).
67+
### Tailwind for CSS Development
68+
69+
We use [TailwindCSS](https://tailwindcss.com) for our component styling. Check out the [tailwind.config.js](tailwind.config.js) file for configured tailwind features, colors, border-radius values etc.. If you are not familiar with Tailwind, check out existing components for inspiration.
70+
71+
We sometimes also need to fall back to common css (with tailwind `@apply` directives to enforce our style system). You can find the CSS main entrypoint in [styles/main.css](styles/main.css).
9772

9873
**Only fall back to plain CSS if absolutely necessary**
9974

100-
Most of the stuff we want to build can be built as components with Tailwind
101-
classes. We mostly use global CSS if we need to interact with 3rd party code
102-
(such as `highlightjs`), or if we need features like child selectors (markdown
103-
rendering with nested lists).
75+
Most of the stuff we want to build can be built as components with Tailwind classes. We mostly use global CSS if we need to interact with 3rd party code (such as `highlightjs`), or if we need features like child selectors (markdown rendering with nested lists).
10476

10577
## PR process
10678

10779
- Clone the project and follow the [README](README.md) instructions
10880
- Always run the page locally and verify your changes (especially when working on code examples)
10981
- When writing markdown with code examples, always run `yarn test` to prevent broken code
110-
- Feel free to open `Draft PRs` when you are working on bigger features (good
111-
for visibility and asking for feedback)
82+
- Feel free to open `Draft PRs` when you are working on bigger features (good for visibility and asking for feedback)

0 commit comments

Comments
 (0)