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
+34-8Lines changed: 34 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,38 @@
1
-
Thanks for contributing — you rock! 🤘
1
+
# Thanks for contributing — you rock! 🤘<!-- omit in toc -->
2
2
3
-
## Maintainers
3
+
-[Development](#development)
4
+
-[Git Workflow](#git-workflow)
5
+
-[Deployments](#deployments)
6
+
-[Storybook](#storybook)
7
+
-[Coding standards](#coding-standards)
8
+
-[Tips to help your PR get approved](#tips-to-help-your-pr-get-approved)
9
+
-[Submitting bug reports and feature requests](#submitting-bug-reports-and-feature-requests)
4
10
5
-
This repo is maintained by [WebDevStudios](https://webdevstudios.com).
11
+
## Development
6
12
7
-
---
13
+
### Git Workflow
8
14
9
-
## Submitting bug reports and feature requests
15
+
1. Create a `feature` branch off `staging`
16
+
2. Work locally adhereing to coding standards
17
+
3. When ready, open a draft Pull Request on Github
18
+
4. When finished, fill out the PR template and publish your PR
19
+
5. Your PR must pass assertions and deploy successfully
20
+
6. After peer review, the PR will be merged back into `staging`
21
+
7. Repeat ♻️
10
22
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).
23
+
### Deployments
12
24
13
-
If you do fill out a bug report, be sure to fill out the report completely!
25
+
[Vercel](https://nextjs-wordpress-starter-gregrickaby.webdevstudios.vercel.app) is connected to this Github repository and will automatically build and deploy. Learn more about [Vercel + Github integration](https://vercel.com/docs/git/vercel-for-github).
26
+
27
+
### Storybook
28
+
29
+
To work with Storybook on your Local, run the following command:
30
+
31
+
```bash
32
+
yarn storybook
33
+
```
14
34
15
-
---
35
+
Stories are written in `.mdx` and should be placed next to the component. Learn more about [Storybook](https://storybook.js.org/).
16
36
17
37
## Coding standards
18
38
@@ -44,3 +64,9 @@ Format your code:
44
64
```bash
45
65
yarn run format
46
66
```
67
+
68
+
## Submitting bug reports and feature requests
69
+
70
+
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).
71
+
72
+
If you do fill out a bug report, be sure to fill out the report completely!
-[:octocat: Development and Contributing](#octocat-development-and-contributing)
41
37
42
38
---
43
39
@@ -217,33 +213,7 @@ The token can be any random string as long as they match.
217
213
218
214
---
219
215
220
-
## 💻 Frontend Development
221
-
222
-
### Git Workflow
223
-
224
-
1. Create a `feature` branch off `staging`
225
-
2. Work locally adhereing to coding standards
226
-
3. When ready, open a draft Pull Request on Github
227
-
4. When finished, fill out the PR template and publish your PR
228
-
5. Your PR must pass assertions and deploy successfully
229
-
6. After peer review, the PR will be merged back into `staging`
230
-
7. Repeat ♻️
231
-
232
-
### Deployments
233
-
234
-
[Vercel](https://nextjs-wordpress-starter-gregrickaby.webdevstudios.vercel.app) is connected to this Github repository and will automatically build and deploy. Learn more about [Vercel + Github integration](https://vercel.com/docs/git/vercel-for-github).
235
-
236
-
### Storybook
237
-
238
-
To work with Storybook on your Local, run the following command:
239
-
240
-
```bash
241
-
yarn storybook
242
-
```
243
-
244
-
Stories are written in `.mdx` and should be placed next to the component. Learn more about [Storybook](https://storybook.js.org/).
245
-
246
-
## WebDevStudios Specific Info
216
+
## 💻 WebDevStudios Specific Info
247
217
248
218
The following information pertains to internal tools and workflows at WebDevStudios.
At WebDevStudios we are committed to open-source technologies and welcome feedback, [discussions](https://github.com/WebDevStudios/nextjs-wordpress-starter/discussions), and contributions from the community.
313
283
314
-
Please see [CONTRIBUTING.md](https://github.com/WebDevStudios/nextjs-wordpress-starter/blob/staging/.github/CONTRIBUTING.md) for more info on how to get started contributing.
284
+
Please see [CONTRIBUTING.md](https://github.com/WebDevStudios/nextjs-wordpress-starter/blob/staging/.github/CONTRIBUTING.md) for more info on how to get started.
0 commit comments