-
Notifications
You must be signed in to change notification settings - Fork 8
Add How to contribute section with linter and editor setup #31
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
| ### 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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
|
(I edited the PR description, changing |
| "takumii.markdowntable", | ||
| "yzhang.markdown-all-in-one", | ||
| "streetsidesoftware.code-spell-checker", |
There was a problem hiding this comment.
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 🤷♀️
This adds a new How to contribute section to the documentation, with:
npm ci./lintor./lint --fix)takumii.markdowntableHelps edit and format markdown tables more easily. Great for keeping tables aligned and readable in README files.
yzhang.markdown-all-in-oneA comprehensive markdown toolkit. Provides features like table of contents generation, shortcuts for formatting, and enhanced markdown preview.
streetsidesoftware.code-spell-checkerAdds spell checking for markdown (and code comments). Helps catch typos in documentation and maintain a polished appearance.
editorconfig.editorconfigReads
.editorconfigsettings to ensure consistent indentation, line endings, and other coding style rules across different editors and contributors.