This project follows AirBnB coding standards. ESLint will report any style violations when tests are run or
with npm run lint
Some style violations can automatically be fixed by running npm run fix
The project has extensive test coverage with Jest.
Run the test-suite a single time with npm run test. To watch and automatically execute on file change
run npm run test:watch.
All Pull Requests should have 100% test-covered. Run npm run test:coverage to see a report.
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) |
| core | Changes to the core package |
| json-api | Changes to the json-api package |
| vue | Changes to the vue 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 |
See conventional-changelog/commitlint for a complete list of types and other rules.
-
Fork this repo
-
Clone your fork:
git clone https://github.com/your-username/Hyral.git cd Hyral -
Create a feature branch:
git checkout -b your-feature-name
-
Install dependencies:
npm install
-
Test changes
npm run test -
Commit changes:
git commit -am 'feat: add feature name' -
Push changes:
git push origin your-feature-name
-
Open a pull request