Browse Source

Update docs.

pull/3/merge
Ned Zimmerman 7 years ago
parent
commit
e11f60f4df
No known key found for this signature in database
GPG Key ID: FF56334A013120CA
  1. 74
      .github/CODE_OF_CONDUCT.md
  2. 4
      .github/CONTRIBUTING.md
  3. 68
      .github/ISSUE_TEMPLATE.md

74
.github/CODE_OF_CONDUCT.md

@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct
## Our Pledge
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, or sexual identity and
orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
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.
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.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [code@pressbooks.com](mailto:code@pressbooks.com). All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/

4
.github/CONTRIBUTING.md

@ -1 +1,3 @@
Please read [Contributing to Roots Projects](https://github.com/roots/guidelines/blob/master/CONTRIBUTING.md)
# Contributing
Issues related to this theme and its use on the root site of a Pressbooks network are welcomed on this repository. Issues related to general functionality of Pressbooks should be posted to [pressbooks/pressbooks](https://github.com/pressbooks/pressbooks). All contributions are subject to the [Contributor Code of Conduct](https://github.com/pressbooks/pressbooks-publisher/blob/master/.github/CODE_OF_CONDUCT.md).

68
.github/ISSUE_TEMPLATE.md

@ -1,62 +1,26 @@
## Submit a feature request or bug report
### Prerequisites
- [ ] I've read the [guidelines for Contributing to Roots Projects](https://github.com/roots/guidelines/blob/master/CONTRIBUTING.md)
- [ ] This is a feature request
- [ ] This is a bug report
- [ ] This request isn't a duplicate of an [existing issue](https://github.com/roots/sage/issues)
- [ ] I've read the [docs](https://roots.io/sage/docs) and [NPM Debugging Guidelines post](https://discourse.roots.io/t/npm-debugging-guidelines-failed-npm-install-bower-install-or-gulp-build-read-this/3060) and followed them (if applicable)
- [ ] This is not a personal support request that should be posted on the [Roots Discourse](https://discourse.roots.io/c/sage) forums
_Check the boxes below by changing them from `[ ]` to `[x]`._
<!-- Replace any `X` with your information. -->
* [ ] Can you reproduce the behavior you wish to address with [all plugins except Pressbooks deactivated](http://codex.wordpress.org/Multisite_Network_Administration#Plugins)?
* [ ] Are you running the [latest version of Pressbooks](http://github.com/pressbooks/pressbooks/releases/latest/), the latest version of [Aldine](http://github.com/pressbooks/pressbooks-aldine/releases/latest/), and the [latest version of WordPress](http://codex.wordpress.org/Upgrading_WordPress)?
* [ ] Are you experiencing the issue while using Aldine as your network's root theme?
* [ ] Did you [perform a cursory search](https://github.com/issues?q=+is%3Aissue+repo%3Apressbooks%2Fpressbooks-aldine) to see if your bug or enhancement is already listed?
---
### Description
**What is the current behavior?**
[Description of the bug or feature]
X
### Steps to Reproduce
1. [First Step]
2. [Second Step]
3. [and so on...]
**What is the expected or desired behavior?**
**Expected behavior:** [What you expected to happen]
X
**Actual behavior:** [What actually happened]
---
### System Information
## Bug report
<!-- (delete this section if not applicable) -->
**Please provide steps to reproduce, including full log output:**
X
**Please describe your local environment:**
WordPress version: X
OS: X
NPM/Node version: X
**Where did the bug happen? Development or remote servers?**
X
**Is there a related [Discourse](https://discourse.roots.io/) thread or were any utilized (please link them)?**
X
---
## Feature Request
<!-- (delete this section if not applicable) -->
**Please provide use cases for changing the current behavior:**
X
**Other relevant information:**
X
_Replace this section with the contents of the Diagnostics page, available at `https://<yourdomain.tld>/<yourbook>/wp-admin/options.php?page=pressbooks_diagnostics` or via the Diagnostics link in the admin footer._

Loading…
Cancel
Save