This project follows JavaScript Standard Style with a couple of tweaks. ESLint will report any style violations when tests are run or with yarn lint
Some style violations can automatically be fixed by running yarn fix
Semantic commit messages are used:
feat(category): added feature x
| Category | Usage |
|---|---|
empty |
Changes to monorepo, no change to packages (alternatively, the filename - e.g readme) |
| kitsu | Changes to the kitsu package |
| kitsu-core | Changes to the kitsu-core package |
| Type | Usage |
|---|---|
| ci | Continuous Integration changes |
| chore | Build scripts, no production code change |
| feat | New feature/enhancement |
| fix | Fix a bug for users - not build related issues |
| refactor | Refactoring production code, optimisations |
| style | Formatting changes, no code change |
| test | Adding, refactoring or fixing tests |
-
Fork this repo
-
Clone your fork:
git clone https://github.com/your-username/kitsu.git cd kitsu -
Create a feature branch:
git checkout -b your-feature-name
-
Install dependencies:
yarn # or npm install -
Test changes
yarn test # or npm test -
Commit changes:
git commit -am 'feat: add feature name' -
Push changes:
git push origin your-feature-name
-
Open a pull request