Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"recommendations": [
"takumii.markdowntable",
"yzhang.markdown-all-in-one",
"streetsidesoftware.code-spell-checker",
Comment on lines +3 to +5
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not quite convinced about all these (yet), but they are only recommendations, so 🤷‍♀️

"editorconfig.editorconfig"
]
}
44 changes: 41 additions & 3 deletions contributing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,55 @@ Write in there to introduce yourself, and a staff member will onboard you and se

## How to contribute

(We will flesh these processes more as we go...)
This project is a collection of structured README files. To maintain consistency and quality, we use a linter and suggest some recommended editor extensions.

### 1. Install dependencies

First, make sure you have [Node.js](https://nodejs.org/) installed.

Then, install the project dependencies using:

```bash
npm ci
```

This ensures a clean and reproducible setup based on the `package-lock.json`.

### 2. Set up your editor (optional but recommended)

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.

These extensions help with linting and maintaining the project’s standards.

### 3. Make your changes

Edit or create README files as needed. Follow the existing formatting and writing style.

### 4. Run the linter

Before committing your changes, make sure everything passes the linter.

To check for linting issues:

```bash
./lint
```

To automatically fix some issues:

```bash
./lint --fix
```

### Existing issues

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.

### New ideas

Very briefly: Create an issue on this repo, get some feedback, and we'll prioritise them together at the next meeting.
Very briefly: Create an issue on this repo, get some feedback, and we'll prioritize them together at the next meeting.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the reasoning here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically: do we want to make a conscious decision to standardise on en-GB, or en-US, or some other locale — or do we make a conscious decision that we don't care about the locales (and therefore spelling) that much?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I write in en-GB by default (I'm from England) so you'll see that from me unless we decide otherwise. This repo is also called "programme" which I'm pretty sure is en-GB as well... :D

Saying that, we should probably choose/enforce one in the future, but at this point I don't have strong opinions. I'm approving it for now, with this change, regardless.


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

## How permissions work

Expand Down