You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributing/README.md
+41-3Lines changed: 41 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,17 +7,55 @@ Write in there to introduce yourself, and a staff member will onboard you and se
7
7
8
8
## How to contribute
9
9
10
-
(We will flesh these processes more as we go...)
10
+
This project is a collection of structured README files. To maintain consistency and quality, we use a linter and suggest some recommended editor extensions.
11
+
12
+
### 1. Install dependencies
13
+
14
+
First, make sure you have [Node.js](https://nodejs.org/) installed.
15
+
16
+
Then, install the project dependencies using:
17
+
18
+
```bash
19
+
npm ci
20
+
```
21
+
22
+
This ensures a clean and reproducible setup based on the `package-lock.json`.
23
+
24
+
### 2. Set up your editor (optional but recommended)
25
+
26
+
If you are using [Visual Studio Code](https://code.visualstudio.com/), we have a list of recommended extensions in `.vscode/extensions.json`. When you open the project in VSCode, it will automatically suggest installing them to improve your development experience.
27
+
28
+
These extensions help with linting and maintaining the project’s standards.
29
+
30
+
### 3. Make your changes
31
+
32
+
Edit or create README files as needed. Follow the existing formatting and writing style.
33
+
34
+
### 4. Run the linter
35
+
36
+
Before committing your changes, make sure everything passes the linter.
37
+
38
+
To check for linting issues:
39
+
40
+
```bash
41
+
./lint
42
+
```
43
+
44
+
To automatically fix some issues:
45
+
46
+
```bash
47
+
./lint --fix
48
+
```
11
49
12
50
### Existing issues
13
51
14
52
Very briefly: check the project board "Todo" column, choose one ideally near the top, assign it, clone the repo, do it, make a PR, get feedback, profit.
15
53
16
54
### New ideas
17
55
18
-
Very briefly: Create an issue on this repo, get some feedback, and we'll prioritise them together at the next meeting.
56
+
Very briefly: Create an issue on this repo, get some feedback, and we'll prioritize them together at the next meeting.
19
57
20
-
Note: You are always welcome to open issues/create PRs for new ideas, whenever you like. It's an open source project. If we are currently working together towards a project goal, then it would be most helpful to prioritise tasks for that first, though.
58
+
Note: You are always welcome to open issues/create PRs for new ideas, whenever you like. It's an open source project. If we are currently working together towards a project goal, then it would be most helpful to prioritize tasks for that first, though.
0 commit comments