Skip to content

Commit f2ac25f

Browse files
Merge pull request #31 from HackYourFuture-CPH/how-to-contribute
Add How to contribute section with linter and editor setup
2 parents 574c38d + ca5e84d commit f2ac25f

File tree

2 files changed

+49
-3
lines changed

2 files changed

+49
-3
lines changed

.vscode/extensions.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"recommendations": [
3+
"takumii.markdowntable",
4+
"yzhang.markdown-all-in-one",
5+
"streetsidesoftware.code-spell-checker",
6+
"editorconfig.editorconfig"
7+
]
8+
}

contributing/README.md

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,55 @@ Write in there to introduce yourself, and a staff member will onboard you and se
77

88
## How to contribute
99

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+
```
1149

1250
### Existing issues
1351

1452
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.
1553

1654
### New ideas
1755

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.
1957

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.
2159

2260
## How permissions work
2361

0 commit comments

Comments
 (0)