@duetds/date-picker
Version:
Duet Date Picker is an open source version of Duet Design System’s accessible date picker.
115 lines (65 loc) • 3.75 kB
Markdown
# Contributing to jest-image-snapshot
✨ Thank you for taking the time to contribute to this project ✨
## 📖 Table of Contents
* [Code of Conduct](#code-of-conduct)
* [Developing](#developing)
* [Submitting a new feature](#submitting-a-new-feature)
* [Reporting bugs](#reporting-bugs)
* [Contributing](#getting-in-contact)
* [Coding conventions](#coding-conventions)
## Code of Conduct
This project adheres to the American Express [Code of Conduct](./CODE_OF_CONDUCT.md). By contributing, you are expected to honor these guidelines.
## Developing
### Installation
1. Fork the repository `jest-image-snapshot` to your GitHub account.
2. Afterwards run the following commands in your terminal
```bash
$ git clone https://github.com/<your-github-username>/jest-image-snapshot
$ cd jest-image-snapshot
```
> replace `your-github-username` with your github username
3. Install the dependencies by running
```bash
$ npm install
```
4. You can now run any of these scripts from the root folder.
#### Running tests
- **`npm run lint`**
Verifies that your code matches the American Express code style defined in [`eslint-config-amex`](https://github.com/americanexpress/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](https://www.conventionalcommits.org/) and verifies that the `package-lock.json` file includes public NPM registry URLs.
## Submitting a new feature
When submitting a new feature request or enhancement of an existing feature please review the following:-
### Is your feature request related to a problem
Please provide a clear and concise description of what you want and what your use case is.
### Provide an example
Please include a snippets of the code of the new feature.
### Describe the suggested enhancement
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
### Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
## Reporting bugs
All issues are submitted within GitHub issues. Please check this before submitting a new issue.
### Describe the bug
A clear and concise description of what the bug is.
### Provide step-by-step guide on how to reproduce the bug
Steps to reproduce the behavior, please provide code snippets or a link to repository
### Expected behavior
Please provide a description of the expected behavior
### Screenshots
If applicable, add screenshots or animated GIFs to help explain your problem.
### System information
Provide the system information which is not limited to the below:
- Browser (if applies) [e.g. chrome, safari]
- Version of jest-image-snapshot: [e.g. 5.0.0]
- Node version:[e.g 10.15.1]
### Security Bugs
Please review our [Security Policy](./SECURITY.md). Please follow the instructions outlined in the policy.
## Getting in contact
- Join our [Slack channel](https://one-amex.slack.com) request an invite [here](https://join.slack.com/t/one-amex/shared_invite/enQtOTA0MzEzODExODEwLTlmYzI1Y2U2ZDEwNWJjOTAxYTlmZTYzMjUyNzQyZTdmMWIwZGJmZDM2MDZmYzVjMDk5OWU4OGIwNjJjZWRhMjY)
## Coding conventions
### Git Commit Guidelines
We follow [conventional commits](https://www.conventionalcommits.org/) 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.