Thank you for investing your time in contributing to our project!
Read our Code of Conduct to keep our community approachable and respectable.
To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:
- Finding ways to contribute to open source on GitHub
- Collaborating with pull requests
- GitHub flow
- Conventional commits
- ESLint
- Fork the repo
- Set up Git
- Set up Node.js
- Run test and lint to validate your commit with GitHooks for Node.js
git clone https://github.com/JadsonLucena/SignedAccess.js
cd SignedAccess.js
npm install
npm testIf you spot a problem in the project, search if an issue already exists.
You can narrow down the search using labels as filters.
If you feel an open-ended discussion with the community and maintainers would be more suitable to forming the right details for your feature request, you can post in Discussions instead.
As a general rule, we don’t assign issues to anyone.
If you find an issue to work on, you are welcome to open a PR with a fix.
If a related issue doesn't exist, you can open a new issue using a relevant issue form.
When you're finished with the changes, create a pull request, also known as a PR.
- Search for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts.
- Submit the PR to the Develop branch
- Don't forget to link PR to issue if you are solving one.
- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge.
- After submitting your PR, it will undergo code review by the maintainers
To ensure consistency throughout the source code, keep these rules in mind as you are working:
- All features or bug fixes must be tested by one or more specs (unit-tests).
- All public API methods must be documented.
- Where applicable, follow standards:
- TDD
- SOLID
- Object Calisthenics
- Clean Code
- Designer Partner
- JavaScript Standard Style Guide