Skip to content

Conversation

@urbanogilson
Copy link
Member

@urbanogilson urbanogilson commented Apr 26, 2025

This adds a new How to contribute section to the documentation, with:

  • Instructions for installing Node.js dependencies using npm ci
  • Details on how to run the linter (./lint or ./lint --fix)
  • A note about recommended VSCode extensions from .vscode/extensions.json
    • takumii.markdowntable
      Helps edit and format markdown tables more easily. Great for keeping tables aligned and readable in README files.

    • yzhang.markdown-all-in-one
      A comprehensive markdown toolkit. Provides features like table of contents generation, shortcuts for formatting, and enhanced markdown preview.

    • streetsidesoftware.code-spell-checker
      Adds spell checking for markdown (and code comments). Helps catch typos in documentation and maintain a polished appearance.

    • editorconfig.editorconfig
      Reads .editorconfig settings to ensure consistent indentation, line endings, and other coding style rules across different editors and contributors.

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

@rvedotrc
Copy link
Contributor

(I edited the PR description, changing ./linter to ./lint)

Comment on lines +3 to +5
"takumii.markdowntable",
"yzhang.markdown-all-in-one",
"streetsidesoftware.code-spell-checker",
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 🤷‍♀️

@adamblanchard adamblanchard merged commit f2ac25f into main Apr 28, 2025
1 check passed
@rvedotrc rvedotrc deleted the how-to-contribute branch October 15, 2025 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

5 participants