1 | # Contributing to jest-image-snapshot
|
2 |
|
3 | ✨ Thank you for taking the time to contribute to this project ✨
|
4 |
|
5 | ## 📖 Table of Contents
|
6 |
|
7 | * [Code of Conduct](#code-of-conduct)
|
8 | * [Developing](#developing)
|
9 | * [Submitting a new feature](#submitting-a-new-feature)
|
10 | * [Reporting bugs](#reporting-bugs)
|
11 | * [Contributing](#getting-in-contact)
|
12 | * [Coding conventions](#coding-conventions)
|
13 |
|
14 | ## Code of Conduct
|
15 |
|
16 | This project adheres to the American Express [Code of Conduct](./CODE_OF_CONDUCT.md). By contributing, you are expected to honor these guidelines.
|
17 |
|
18 | ## Developing
|
19 |
|
20 | ### Installation
|
21 |
|
22 | 1. Fork the repository `jest-image-snapshot` to your GitHub account.
|
23 | 2. Afterwards run the following commands in your terminal
|
24 |
|
25 | ```bash
|
26 | $ git clone https://github.com/<your-github-username>/jest-image-snapshot
|
27 | $ cd jest-image-snapshot
|
28 | ```
|
29 |
|
30 | > replace `your-github-username` with your github username
|
31 |
|
32 | 3. Install the dependencies by running
|
33 |
|
34 | ```bash
|
35 | $ npm install
|
36 | ```
|
37 |
|
38 | 4. You can now run any of these scripts from the root folder.
|
39 |
|
40 | #### Running tests
|
41 |
|
42 | - **`npm run lint`**
|
43 |
|
44 | Verifies that your code matches the American Express code style defined in [`eslint-config-amex`](https://github.com/americanexpress/eslint-config-amex).
|
45 |
|
46 | - **`npm test`**
|
47 |
|
48 | Runs unit tests **and** verifies the format of all commit messages on the current branch.
|
49 |
|
50 | - **`npm posttest`**
|
51 |
|
52 | 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.
|
53 |
|
54 | ## Submitting a new feature
|
55 |
|
56 | When submitting a new feature request or enhancement of an existing feature please review the following:-
|
57 |
|
58 | ### Is your feature request related to a problem
|
59 |
|
60 | Please provide a clear and concise description of what you want and what your use case is.
|
61 |
|
62 | ### Provide an example
|
63 |
|
64 | Please include a snippets of the code of the new feature.
|
65 |
|
66 | ### Describe the suggested enhancement
|
67 |
|
68 | A clear and concise description of the enhancement to be added include a step-by-step guide if applicable.
|
69 | Add any other context or screenshots or animated GIFs about the feature request
|
70 |
|
71 | ### Describe alternatives you've considered
|
72 |
|
73 | A clear and concise description of any alternative solutions or features you've considered.
|
74 |
|
75 | ## Reporting bugs
|
76 |
|
77 | All issues are submitted within GitHub issues. Please check this before submitting a new issue.
|
78 |
|
79 | ### Describe the bug
|
80 |
|
81 | A clear and concise description of what the bug is.
|
82 |
|
83 | ### Provide step-by-step guide on how to reproduce the bug
|
84 |
|
85 | Steps to reproduce the behavior, please provide code snippets or a link to repository
|
86 |
|
87 | ### Expected behavior
|
88 |
|
89 | Please provide a description of the expected behavior
|
90 |
|
91 | ### Screenshots
|
92 |
|
93 | If applicable, add screenshots or animated GIFs to help explain your problem.
|
94 |
|
95 | ### System information
|
96 |
|
97 | Provide the system information which is not limited to the below:
|
98 |
|
99 | - Browser (if applies) [e.g. chrome, safari]
|
100 | - Version of jest-image-snapshot: [e.g. 5.0.0]
|
101 | - Node version:[e.g 10.15.1]
|
102 |
|
103 | ### Security Bugs
|
104 |
|
105 | Please review our [Security Policy](./SECURITY.md). Please follow the instructions outlined in the policy.
|
106 |
|
107 | ## Getting in contact
|
108 |
|
109 | - Join our [Slack channel](https://one-amex.slack.com) request an invite [here](https://join.slack.com/t/one-amex/shared_invite/enQtOTA0MzEzODExODEwLTlmYzI1Y2U2ZDEwNWJjOTAxYTlmZTYzMjUyNzQyZTdmMWIwZGJmZDM2MDZmYzVjMDk5OWU4OGIwNjJjZWRhMjY)
|
110 |
|
111 | ## Coding conventions
|
112 |
|
113 | ### Git Commit Guidelines
|
114 |
|
115 | 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. |
\ | No newline at end of file |