Skip to content
Permalink
master
Switch branches/tags

regex-for-regular-folk/contribution.md

Go to file
 
 
Cannot retrieve contributors at this time
Contributing to REFRF How can I contribute? Writing Translating Web Development Environment Development web server Style Commit messages Code and markdown files Language guidelines
83 lines (54 sloc) 1.91 KB
Raw Blame
Open in GitHub Desktop

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.

Writing

  • Correct technical inaccuracies
  • Proofread
  • Add examples and/or illuminating test cases
  • Improve explanations
  • Add chapters
  • Add translations
  • 🎤…

Translating

  1. Create a directory within chapters/ with the two-letter ISO code of the language you're translating to (en for English, fr for French, …).
  2. Duplicate the contents of chapters/en/ into the new directory.
  3. Translate the newly created files. Do not translate the names of the files themselves.
  4. Create a PR!

Web Development

  • Refactor code for components and layouts
  • Resolve our open issues
  • 🎤…

Environment

Clone the repo:

git clone git@github.com:shreyasminocha/regex-for-regular-folk.git refrf
cd refrf

Assuming you have npm and node installed, install dependencies:

npm install

Development web server

npm run dev

Style

Commit messages

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

Language guidelines

We use British English.