Skip to content
This repository was archived by the owner on Feb 27, 2024. It is now read-only.

Commit 388f22e

Browse files
committed
update contributing
1 parent 8dddbfe commit 388f22e

File tree

1 file changed

+35
-7
lines changed

1 file changed

+35
-7
lines changed

.github/CONTRIBUTING.md

Lines changed: 35 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,43 @@ Thanks for contributing — you rock! 🤘
44

55
This repo is maintained by [WebDevStudios](https://webdevstudios.com).
66

7-
## Submitting issues
7+
---
88

9-
Before submitting your issue, make sure it has not been discussed earlier. You can search for existing tickets [here](https://github.com/WebDevStudios/nextjs-wordpress-starter/issues).
9+
## Submitting bug reports and feature requests
1010

11-
## Contributing code
11+
Before submitting an issue or making a feature request, please search for existing [issues](https://github.com/WebDevStudios/nextjs-wordpress-starter/issues) or look at our [Github Discussions](https://github.com/WebDevStudios/nextjs-wordpress-starter/discussions).
1212

13-
Found a bug you can fix? Fantastic! Patches are always welcome. Here's a few tips for crafting a great pull request:
13+
If you do fill out a bug report, be sure to fill out the report completely!
1414

15-
- Include the purpose of your PR. Be explicit about the issue your PR solves. Fill out the Pull Request template completely.
16-
- Reference any existing issues that relate to your PR. This allows everyone to easily see all related discussions.
15+
---
1716

18-
By contributing code to Kindergarten Flashcards, you grant its use under the [GNU General Public License v2 (or later)](LICENSE).
17+
## Coding standards
18+
19+
Pull requests _must pass_ all assertions and component changes will be reviewed in Chromatic prior to consideration.
20+
21+
### Tips to help your PR get approved
22+
23+
1. Make sure your code editor supports real-time linting.
24+
2. JSDocs are important and must be completely filled out.
25+
3. Run `yarn build && yarn start` before submitting your PR, to ensure a build will be successful
26+
4. Be courteous
27+
28+
In addition to real-time linting, you could run the following commands in your terminal (these commands are also used by Husky during a commit!)
29+
30+
Lint JavaScript:
31+
32+
```bash
33+
yarn run lint:js
34+
```
35+
36+
Lint CSS:
37+
38+
```bash
39+
yarn run lint:css
40+
```
41+
42+
Format your code:
43+
44+
```bash
45+
yarn run format
46+
```

0 commit comments

Comments
 (0)