Skip to content

Commit 4de3538

Browse files
authored
docs: Add 'How to Contribute' documentation (#10)
* docs: Add 'How to Contribute' documentation * docs: Minor 'Code of conduct' edits
1 parent 4408c16 commit 4de3538

File tree

3 files changed

+72
-0
lines changed

3 files changed

+72
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,10 @@ This is a starter to fast-track WordPress websites. It provides a way to skip ma
1414
| [CSS Class Reference](docs/css.md) |
1515
| [Page Templates](docs/page-templates.md) |
1616
| [Deployment](docs/deployment.md) |
17+
| [How to Contribute](docs/contributing.md) |
1718

1819
## SparkPress Team
20+
- **[Kasey Bonifacio](https://github.com/kaseybon)**
1921
- **[Ricardo Fearing](https://github.com/rfearing)**
2022
- **[Rob Tarr](https://github.com/robtarr)**
2123
- **[Philip Zastrow](https://github.com/zastrow/)**

docs/code-of-conduct.md

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

docs/contributing.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Contribute
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. Make sure any committed code follows the project's [style guide][styleguide].
9+
1. All contributions must follow our [code of conduct](code-of-conduct.md)
10+
11+
## Contribution Workflow
12+
13+
1. Fork and clone this repo.
14+
2. Make your changes on a [feature-branch](https://bocoup.com/weblog/git-workflow-walkthrough-feature-branches).
15+
3. Submit a Pull Request to the `main` branch.
16+
17+
[styleguide]:https://github.com/sparkbox/sparkpress/blob/main/docs/development.md#linting
18+
[issues]:https://github.com/sparkbox/sparkpress/issues

0 commit comments

Comments
 (0)