You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 27, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+35-7Lines changed: 35 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,15 +4,43 @@ Thanks for contributing — you rock! 🤘
4
4
5
5
This repo is maintained by [WebDevStudios](https://webdevstudios.com).
6
6
7
-
## Submitting issues
7
+
---
8
8
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
10
10
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).
12
12
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!
14
14
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
+
---
17
16
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!)
0 commit comments