Skip to content

Latest commit

 

History

History
15 lines (11 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

15 lines (11 loc) · 1.11 KB
Raw

Contributing

If you wish to contribute to Obscenity, feel free to fork the repository and submit a pull request. We use ESLint and Prettier to enforce a consistent code style and catch possible issues; setting up relevant plugins for your editor of choice is highly recommended.

Setup

Prerequisites: Node.js (preferably latest version, but any version >= 12 will work), and pnpm for managing packages.

  1. Fork & clone the main repository.
  2. Create a new branch for your changes: git checkout -b feat/my-feature.
  3. Run pnpm install to install all dependencies.
  4. Make your changes.
  5. Run pnpm lint and pnpm style to lint and format the code. Then, run pnpm test to make sure all the tests are still passing after your change.
  6. Commit your changes (make sure you follow our commit convention, which is based off Angular's commit message guidelines).
  7. Submit a pull request.