From 64d051ce4a6f4fae6ad5c827f89a046070800ad9 Mon Sep 17 00:00:00 2001 From: Ned Zimmerman Date: Wed, 21 Jun 2017 10:05:55 -0300 Subject: [PATCH] Update documentation. --- .editorconfig | 21 +++++++++++ .github/CODE_OF_CONDUCT.md | 74 ++++++++++++++++++++++++++++++++++++++ .github/CONTRIBUTING.md | 3 ++ .github/ISSUE_TEMPLATE.md | 30 ++++++++++++++++ LICENSE.md | 7 ++++ README.md | 31 ++++++++++++++++ composer.json | 5 ++- package.json | 3 +- style.css | 5 +-- 9 files changed, 174 insertions(+), 5 deletions(-) create mode 100644 .editorconfig create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 LICENSE.md diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..524a992 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,21 @@ +# This file is for unifying the coding style for different editors and IDEs +# editorconfig.org + +# WordPress Coding Standards +# https://make.wordpress.org/core/handbook/coding-standards/ + +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +indent_style = tab + +[{.jshintrc,*.json,*.yml,*.scss}] +indent_style = space +indent_size = 2 + +[{*.txt,wp-config-sample.php}] +end_of_line = crlf diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..1aba2a6 --- /dev/null +++ b/.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/ diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..9f69d97 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# 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). diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..0005451 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,30 @@ +### Prerequisites + +_Check the boxes below by changing them from `[ ]` to `[x]`._ + +* [ ] Can you reproduce the behavior you wish to address with [all other plugins deactivated](http://codex.wordpress.org/Multisite_Network_Administration#Plugins)? +* [ ] Are you running the [latest version of Pressbooks](http://github.com/pressbooks/pressbooks/releases/latest/) and the [latest version of WordPress](http://codex.wordpress.org/Upgrading_WordPress)? +* [ ] Did you [perform a cursory search](https://github.com/issues?q=+is%3Aissue+repo%3Apressbooks%2Fpressbooks) to see if your bug or enhancement is already listed? + +### Description + +[Description of the bug or feature] + +### Steps to Reproduce + +1. [First Step] +2. [Second Step] +3. [and so on...] + +**Expected behavior:** [What you expected to happen] + +**Actual behavior:** [What actually happened] + +### System Information + +_Enter the relevant information from the Diagnostics page, available at `https:////wp-admin/options.php?page=pressbooks_diagnostics` or via the Diagnostics link in the admin footer._ + +Root Theme: [Enter root theme name and version here] +Pressbooks: [Enter Pressbooks version here] +WordPress: [Enter WordPress version here] +PHP: [Enter PHP version here] diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..361e784 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,7 @@ +Copyright 2017 Pressbooks (Book Oven Inc.) + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index e69de29..45f6a76 100755 --- a/README.md +++ b/README.md @@ -0,0 +1,31 @@ +# Pressbooks Publisher + +[![Packagist](https://img.shields.io/packagist/l/pressbooks/pressbooks-publisher.svg)](https://packagist.org/packages/pressbooks/pressbooks-publisher) [![Packagist](https://img.shields.io/packagist/v/pressbooks/pressbooks-publisher.svg)](https://packagist.org/packages/pressbooks/pressbooks-publisher) + +The default theme for the root site on Pressbooks installations. + +## Requirements + +* PHP >= 5.6 +* WordPress >= 4.8.0 +* Pressbooks >= 4.0. + +## Installation + +### Manual + +Download the [latest release](https://github.com/pressbooks/pressbooks-publisher/releases/latest/) and unzip the contents to `WP_CONTENT_DIR . '/themes/pressbooks-publisher/'`. + +### Composer + +From within your WordPress or [Bedrock](https://roots.io/bedrock/) root directory, run: + +``` +composer require pressbooks/pressbooks-publisher +``` + +### GitHub Updater + +Install the [GitHub Updater plugin](https://github.com/afragen/github-updater). + +Then, from the GitHub Updater interface, navigate to the "Install Theme" tab. Enter [https://github.com/pressbooks/pressbooks-publisher](https://github.com/pressbooks/pressbooks-publisher) as the Theme URI, then click "Install Theme". Tagged updates to this theme will then be available as normal WordPress updates. diff --git a/composer.json b/composer.json index df05c1b..896df69 100644 --- a/composer.json +++ b/composer.json @@ -3,11 +3,14 @@ "description": "The default theme for the root site on Pressbooks installations.", "type": "wordpress-theme", "require": { - "composer/installers": "^1.3" + "composer/installers": "~1.3" }, "require-dev": { "humanmade/coding-standards": "^0.2.1" }, + "archive": { + "exclude": [".github"] + }, "license": "MIT", "authors": [ { diff --git a/package.json b/package.json index 54cfc84..6d8910b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,5 @@ { "name": "pressbooks-publisher", - "version": "3.0.1", "author": "Pressbooks (Book Oven Inc.) ", "homepage": "https://pressbooks.org/", "private": true, @@ -24,7 +23,7 @@ }, "engines": { "node": ">= 0.12.0", - "npm": ">=2.1.5" + "npm": ">= 2.1.5" }, "devDependencies": { "asset-builder": "^1.1.0", diff --git a/style.css b/style.css index 4899f15..12e691a 100755 --- a/style.css +++ b/style.css @@ -3,6 +3,7 @@ Theme Name: Pressbooks Publisher Author: Pressbooks (Book Oven Inc.) Author URI: https://pressbooks.com Description: The default theme for the root site on Pressbooks installations. -Version: 3.0.1 -Text Domain: pressbooks +Version: 3.0.2 +Text Domain: pressbooks-publisher +GitHub Theme URI: pressbooks/pressbooks-publisher */