accessible-menu

accessible-menu

A JavaScript library to help you generate WAI-ARIA accessible menus in the DOM.

Committing

This project uses the conventional commit standard, which means your commits should follow a basic template of:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

For more detailed information about available types, scopes, breaking changes, etc. please see the official documentation.

This project also provides a command to assist you in formatting commit messages using commitizen:

npm run commit

Versioning

This project uses Semantic Versioning 2.0.0 to keep track of releases.

Given a version number MAJOR.MINOR.PATCH, increment the:

1. MAJOR version when you make incompatible API changes,
2. MINOR version when you add functionality in a backward compatible manner, and
3. PATCH version when you make backwards compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

For more detailed information about SemVer, please see the official documentation.

When making a release, you should use the provided command:

npm run release

This command uses standard-version to parse through your commits, decide what kind of release will be created, and automatically generates a CHANGELOG.md file for your project. These changes are then commited using the message chore(release): <version number>.

Once that is done, you can simply run git push --follow-tags origin to have your release pushed up to the repository.

Coding standards

This project follows a set of coding standards combining StandardJS, Prettier, and JSDoc.

To check your code, you can use ESLint with the provided script:

npm run lint

You can also fix some violations automatically using:

npm run fix