✨ Thank you for taking the time to contribute to this project ✨
This project adheres to the American Express Code of Conduct. By contributing, you are expected to honor these guidelines.
-
Fork the repository
create-shared-react-context
to your GitHub account. -
Afterwards run the following commands in your terminal
$ git clone https://github.com/<your-github-username>/create-shared-react-context $ cd create-shared-react-context
replace
your-github-username
with your github username -
Install the dependencies by running
$ npm install
-
You can now run any of these scripts from the root folder.
npm run lint
Verifies that your code matches the American Express code style defined in
eslint-config-amex
.
npm test
Runs unit tests and verifies the format of all commit messages on the current branch.
npm posttest
Runs linting on the current branch, checks that the commits follow conventional commits and verifies that the package-lock.json
file includes public NPM registry URLs.
When submitting a new feature request or enhancement of an existing feature please review the following:
Please provide a clear and concise description of what you want and what your use case is.
Please include a snippets of the code of the new feature.
A clear and concise description of the enhancement to be added include a step-by-step guide if applicable. Add any other context or screenshots or animated GIFs about the feature request
A clear and concise description of any alternative solutions or features you've considered.
All issues are submitted within GitHub issues. Please check this before submitting a new issue.
A clear and concise description of what the bug is.
Steps to reproduce the behavior, please provide code snippets or a link to repository
Please provide a description of the expected behavior
If applicable, add screenshots or animated GIFs to help explain your problem.
Provide the system information which is not limited to the below:
- OS: [e.g. macOS, Windows]
- Browser (if applies) [e.g. chrome, safari]
- Version of create-shared-react-context: [e.g. 5.0.0]
- Node version:[e.g 10.15.1]
Please review our Security Policy. Please follow the instructions outlined in the policy.
- Join our Slack channel request an invite here
We follow conventional commits for git commit message formatting. These rules make it easier to review commit logs and improve contextual understanding of code changes. This also allows us to auto-generate the CHANGELOG from commit messages.