Contributing to REFRF
Thanks for taking the initiative to contribute to REFRF!
How can I contribute?
Contributions of all sorts are welcome. Check out open issues if you're looking for something to work on.
- Correct technical inaccuracies
- Add examples and/or illuminating test cases
- Improve explanations
- Add chapters
- Add translations
- Create a directory within
chapters/with the two-letter ISO code of the language you're translating to (
frfor French, …).
- Duplicate the contents of
chapters/en/into the new directory.
- Translate the newly created files. Do not translate the names of the files themselves.
- Create a PR!
- Refactor code for components and layouts
- Resolve our open issues
Clone the repo:
git clone firstname.lastname@example.org:shreyasminocha/regex-for-regular-folk.git refrf cd refrf
Assuming you have
node installed, install dependencies:
Development web server
npm run dev
Please format your commit messages according to the seven rules of commit messages. You can look through the repo's commit history for examples.
You can test your commit messages with:
npx seven-rule-msg 'Add advanced examples'
Code and markdown files
We use prettier for formatting our code and mdx files.
Check for formatting errors:
npm run lint-check
Fix formatting errors:
npm run lint
We use British English.