Hey! You're thinking about contributing? That's awesome! You're awesome. Don't know where to start? The best place to get started is visiting our issues to see if there are any you'd like to tackle.
Here's a few things you should know before you submit your PR:
- The purpose of this project is to make getting up and running on a WordPress project quick and simple. By design, it has minimal styles and functionality.
- All contributions must follow our code of conduct
- Clone/Fork the repo
- Install dependencies:
npm install - Start the development process
npm start - Ensure linters pass:
npm run lint - Ensure tests pass:
npm test - Make changes and then make sure the linters and tests still pass
- Push your branch/fork and submit a PR
- Assign a sparkboxer to review your PR
We use Conventional Commits on this project. Commit messages must be prefixed with a valid commit type and the commit type cannot be prefixed with any additional text.
Supported commit types include feat, fix, chore, docs, style, refactor, and test.
Valid example:
feat: add new linting rule for ...Invalid examples:
feature: add new linting rule for ...:sparkles: feat: add new linting rule for ...ℹ️ See the Conventional Commits page for further details on available commit types and how to handle breaking changes.