Skip to content

Commit 746a4a6

Browse files
committed
docs: consolidate documentation into README
- update list of contributors - scaffold README structure and TOC - move development docs into README - scaffold sections for quickstart/customization - update local development/quickstart documentation - move and update wordpress docs section - move and update structure docs to README - move generator docs to README - move plugins docs to README - move custom blocks docs to README - fold CSS docs into project structure - move deployment docs into README - follow GitHub conventions for contributing/code of conduct guides - give a more detailed description of the starter template - use relative path links to repo - add details about what to change for a new project - add details about docker deployment - remove image of limited usefulness - fix typos, missing link, and broken image - fix outdated references
1 parent 0f04f40 commit 746a4a6

15 files changed

+603
-511
lines changed

.env.example

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# Database Environments
22
MYSQL_USER=example_user
3-
MYSQL_PASSWORD=
3+
MYSQL_PASSWORD=example_password
44
MYSQL_DATABASE=example_database
55
MYSQL_HOST=db
6-
MYSQL_ROOT_PASSWORD=
6+
MYSQL_ROOT_PASSWORD=example_root_password
77

88
# Set `WP_ENV` to `yourLastName-local` (ex. `smith-local`).
9-
WP_ENV=sparkuser-local
9+
WP_ENV=example_user-local
1010

1111
# This will replace localhost URLs in the DB on exports, and be replaced by localhost URLs on imports
12-
# Relace "example.com" with your domain name (or the domain name for a staging environment)
12+
# Replace "example.com" with your domain name (or the domain name for a staging environment)
13+
# This needs to be consistent between team members for DB imports/exports to work correctly
1314
SITE_URL=https:\\/\\/example.com

CODE_OF_CONDUCT.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, marital status, color or sex (including pregnancy, sexual orientation, or gender identity).
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Attribution
32+
33+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
34+
35+
[homepage]: http://contributor-covenant.org
36+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing
2+
3+
Hey! You're thinking about contributing? That's awesome! You're awesome. Don't know where to start? The best place to get started is visiting our [issues][issues] to see if there are any you'd like to tackle.
4+
5+
Here's a few things you should know before you submit your PR:
6+
7+
1. The purpose of this project is to make getting up and running on a WordPress project quick and simple. By design, it has minimal styles and functionality.
8+
1. All contributions must follow our [code of conduct](code-of-conduct.md)
9+
10+
## Steps to submit a PR
11+
12+
- Clone/Fork the repo
13+
- Install dependencies: `npm install`
14+
- Install plugin dependencies `npm run plugins:install`
15+
- Start the development process `npm start`
16+
- Ensure linters pass: `npm run lint`
17+
- Ensure tests pass: `npm test`
18+
- Make changes and then make sure the linters and tests still pass
19+
- Push your branch/fork and [submit a PR][pr]
20+
- Assign a [sparkboxer][contributors] to review your PR
21+
22+
## Commit Style
23+
24+
We use [Conventional Commits][conventional commits] on this project. Commit messages must be prefixed with a valid commit type and the commit type cannot be prefixed with any additional text.
25+
26+
Supported commit types include `feat`, `fix`, `chore`, `docs`, `style`, `refactor`, and `test`.
27+
28+
Valid example:
29+
30+
```sh
31+
feat: add new linting rule for ...
32+
```
33+
34+
Invalid examples:
35+
36+
```sh
37+
feature: add new linting rule for ...
38+
```
39+
40+
```sh
41+
:sparkles: feat: add new linting rule for ...
42+
```
43+
44+
ℹ️ See the [Conventional Commits][conventional commits] page for further details on available commit types and how to handle breaking changes.
45+
46+
[issues]: ./issues
47+
[pr]: ./compare
48+
[contributors]: ./graphs/contributors
49+
[conventional commits]: https://www.conventionalcommits.org/en/v1.0.0/

0 commit comments

Comments
 (0)