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

Commit 444f9dd

Browse files
committed
move development workflow to contributing.md
1 parent 4eab161 commit 444f9dd

File tree

2 files changed

+39
-43
lines changed

2 files changed

+39
-43
lines changed

.github/CONTRIBUTING.md

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,38 @@
1-
Thanks for contributing — you rock! 🤘
1+
# Thanks for contributing — you rock! 🤘 <!-- omit in toc -->
22

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)
410

5-
This repo is maintained by [WebDevStudios](https://webdevstudios.com).
11+
## Development
612

7-
---
13+
### Git Workflow
814

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 ♻️
1022

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
1224

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+
```
1434

15-
---
35+
Stories are written in `.mdx` and should be placed next to the component. Learn more about [Storybook](https://storybook.js.org/).
1636

1737
## Coding standards
1838

@@ -44,3 +64,9 @@ Format your code:
4464
```bash
4565
yarn run format
4666
```
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!

README.md

Lines changed: 5 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,15 @@ https://nextjs-wordpress-starter-staging.vercel.app/
2525
- [Dependencies](#dependencies-1)
2626
- [Install](#install-1)
2727
- [Enable Previews](#enable-previews)
28-
- [💻 Frontend Development](#-frontend-development)
29-
- [Git Workflow](#git-workflow)
30-
- [Deployments](#deployments)
31-
- [Storybook](#storybook)
32-
- [WebDevStudios Specific Info](#webdevstudios-specific-info)
28+
- [💻 WebDevStudios Specific Info](#-webdevstudios-specific-info)
3329
- [WordPress Github](#wordpress-github)
3430
- [WP Engine](#wp-engine-1)
3531
- [Chromatic](#chromatic-1)
3632
- [1Password](#1password)
3733
- [Migrate DB Pro](#migrate-db-pro)
3834
- [Algolia](#algolia-1)
3935
- [Copy WP Engine Environments](#copy-wp-engine-environments)
40-
- [:octocat: Contributing](#octocat-contributing)
36+
- [:octocat: Development and Contributing](#octocat-development-and-contributing)
4137

4238
---
4339

@@ -217,33 +213,7 @@ The token can be any random string as long as they match.
217213

218214
---
219215

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
247217

248218
The following information pertains to internal tools and workflows at WebDevStudios.
249219

@@ -307,10 +277,10 @@ WP Engine supports [copying environments](https://wpengine.com/support/copy-site
307277

308278
---
309279

310-
## :octocat: Contributing
280+
## :octocat: Development and Contributing
311281

312282
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.
313283

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.
315285

316286
Stay safe! 🍻

0 commit comments

Comments
 (0)