Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

24 lines (16 loc) · 1.04 KB

Thanks for wanting to help out! These pointers below should help you fall into the pit of success 👇

Contributions we love 💚

  • Replacing the keyword 'unintelligible' with the correct word/phrase (list of unintelligibles)
  • Adding links to referenced URLs, projects, etc.
  • Adding timestamps to key/beloved statements and sections
  • Fixing typos

Contributions we DON'T love 🚫

  • Grammatical changes (what was said was said, grammatical or not)

Conventions 🤝

  • Please review the conventions section of the README before opening a PR

Formatting 📕

This repo has an automatic formatter that applies some style conventions. To run this:

  • Ensure you have the latest stable version of NodeJS installed.
  • run npm install to install dependencies
  • run npm run format to apply formatting changes to the repo
  • run npm run format:test to run the tests for the formatter