Skip to content

Commit

Permalink
Various grammar and wording corrections.
Browse files Browse the repository at this point in the history
  • Loading branch information
noplanman committed Oct 25, 2018
1 parent c8665ae commit 16c5894
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 19 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

First, thank you for taking the time to contribute to [PostTypes](https://github.com/jjgrainger/PostTypes), you're amazing! 🎉 👏 🙌

All contributions are welcome and appreciated. It is recommend you read through this document before making your first contribution.
All contributions are welcome and appreciated. It is recommended that you read through this document before making your first contribution.

The following instructions are recommended as _guidelines_ and not strict rules. However, following this guide will make it easier for both you and the maintainers when working on the project.

Expand All @@ -16,11 +16,11 @@ The following instructions are recommended as _guidelines_ and not strict rules.

PostTypes mission is to _create advanced WordPress custom post types easily_.

It's focus is on the creation of custom post types, specifically around the admin interface, providing methods to create advanced post tables, columns, filters and more.
Its focus is on the creation of custom post types, specifically around the admin interface, providing methods to create advanced post tables, columns, filters and more.

It also makes it easy to create taxonomies and assign them to post types.

Although its focus is on the admin interface, PostTypes **is not for custom fields**. There a plenty of solutions for creating custom fields in WordPress. PostTypes has no intention of being one.
Although its focus is on the admin interface, PostTypes **is not for custom fields**. There are plenty of solutions for creating custom fields in WordPress. PostTypes has no intention of being one.

Please keep this in mind when contributing to the project.

Expand Down Expand Up @@ -50,7 +50,7 @@ Bug reports highlight an an error or unexpected behaviour when using the code. I

### 🚀 Feature Request

Feature request suggest an idea for an improvement or additional functionality. Feature requests should be raised **before submitting a [pull request](#submit-a-pull-request)**. This provides an opportunity for discussion and help prevent unescessary work from being carried out.
Feature requests suggest an idea for an improvement or additional functionality. Feature requests should be raised **before submitting a [pull request](#submit-a-pull-request)**. This provides an opportunity for discussion and help prevent unnecessary work from being carried out.

**Tips on creating feature requests:**

Expand Down Expand Up @@ -107,7 +107,7 @@ This is not an exhaustive list. Labels may be changed and new ones created over
1. Create a branch with one of the relevant [branch prefixes](#branch-prefixes).
1. Commit work to your branch.
1. Push your branch to your fork on GitHub.
1. Create a [pull request](https://github.com/jjgrainger/PostTypes/compare) comparing your forks branch against the main repositories `master`.
1. Create a [pull request](https://github.com/jjgrainger/PostTypes/compare) comparing your forks branch against the main repository's `master`.

**Tips on creating pull requests:**

Expand All @@ -130,13 +130,13 @@ Branch prefixes are used to help categorise the working branches by type.

The `release/` prefix is to be used by **maintainers only**.

The `docs/` prefix is used in alongside [Gitbook](https://www.gitbook.com/) where the docs are hosted. Branches with this prefix will be automatically generated and available as a version on the [documentation site](https://posttypes.jjgrainger.co.uk). This provides an opportunity to preview changes and approve them before being merged.
The `docs/` prefix is used alongside [Gitbook](https://www.gitbook.com/) where the docs are hosted. Branches with this prefix will be automatically generated and made available as a version on the [documentation site](https://posttypes.jjgrainger.co.uk). This provides an opportunity to preview changes and approve them before being merged.

## Show Support

PostTypes is open source and free to use. It was created to solve a problem while giving something back to the community. There are many ways to show your support, some ideas include:

* Creating a [issue](https://github.com/jjgrainger/PostTypes/issues/new) and [pull requests](https://github.com/jjgrainger/PostTypes/compare).
* Creating an [issue](https://github.com/jjgrainger/PostTypes/issues/new) and [pull requests](https://github.com/jjgrainger/PostTypes/compare).
* [Staring](https://github.com/jjgrainger/PostTypes/stargazers) the project on GitHub.
* Saying "thank you" over on [Twitter](https://twitter.com/jjgrainger)
* Spread the word and let others know.
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Run the following in your terminal to install PostTypes with [Composer](https://
$ composer require jjgrainger/posttypes
```

PostTypes uses [PSR-4](http://www.php-fig.org/psr/psr-4/) autoloading and cand be used with Composers autoloader. Below is a basic example of getting started, though your setup maybe different depending on how you are using Composer.
PostTypes uses [PSR-4](http://www.php-fig.org/psr/psr-4/) autoloading and cand be used with Composer's autoloader. Below is a basic example of getting started, though your setup maybe different depending on how you are using Composer.

```php
require __DIR__ . '/vendor/autoload.php';
Expand All @@ -32,7 +32,7 @@ $books = new PostType('book');
$books->register();
```

See Composers [basic usage](https://getcomposer.org/doc/01-basic-usage.md#autoloading) guide for details on working Composer and autoloading.
See Composer's [basic usage](https://getcomposer.org/doc/01-basic-usage.md#autoloading) guide for details on working with Composer and autoloading.

## Basic Usage

Expand Down Expand Up @@ -76,7 +76,7 @@ $genres->register();

* The full documentation can be found online at [posttypes.jjgrainger.co.uk](https://posttypes.jjgrainger.co.uk)
* The class has no methods for making custom fields for post types, use [Advanced Custom Fields](http://advancedcustomfields.com)
* The books example used in the README.md can be found in the [examples/books.php](examples/books.php)
* The books example used in the README.md can be found in [examples/books.php](examples/books.php)
* Licensed under the [MIT License](https://github.com/jjgrainger/wp-posttypes/blob/master/LICENSE)
* Maintained under the [Semantic Versioning Guide](http://semver.org)

Expand Down
4 changes: 2 additions & 2 deletions docs/Getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Run the following in your terminal to install PostTypes with [Composer](https://
$ composer require jjgrainger/posttypes
```

PostTypes uses [PSR-4](http://www.php-fig.org/psr/psr-4/) autoloading and cand be used with Composers autoloader. Below is a basic example of getting started, though your setup maybe different depending on how you are using Composer.
PostTypes uses [PSR-4](http://www.php-fig.org/psr/psr-4/) autoloading and cand be used with Composer's autoloader. Below is a basic example of getting started, though your setup maybe different depending on how you are using Composer.

```php
require __DIR__ . '/vendor/autoload.php';
Expand All @@ -26,7 +26,7 @@ use PostTypes\PostType;
$books = new PostType('book');
```

See Composers [basic usage](https://getcomposer.org/doc/01-basic-usage.md#autoloading) guide for details on working Composer and autoloading.
See Composer's [basic usage](https://getcomposer.org/doc/01-basic-usage.md#autoloading) guide for details on working with Composer and autoloading.

## Basic Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/Notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ The class has no methods for making custom fields for post types, use [Advanced

## Examples

The books example used in the README.md can be found in the [examples/books.php](https://github.com/jjgrainger/posttypes/blob/master/examples/books.php).
The books example used in the README.md can be found in [examples/books.php](https://github.com/jjgrainger/posttypes/blob/master/examples/books.php).
4 changes: 2 additions & 2 deletions docs/post-types/Columns.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Columns

To modify a PostTypes admin columns use the `column()` manager. It has a variety of methods to help fine tune admin table columns.
To modify a PostType's admin columns use the `column()` manager. It has a variety of methods to help fine tune admin table columns.

#### Add Columns

Expand Down Expand Up @@ -51,7 +51,7 @@ $books->columns()->set([

#### Populate Columns

To populate any column use the `populate()` method. and passing the column slug and function.
To populate any column use the `populate()` method, by passing the column slug and a callback function.

```php
$books->columns()->populate('rating', function ($column, $post_id) {
Expand Down
4 changes: 2 additions & 2 deletions docs/post-types/Create-a-post-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The `register()` method hooks into WordPress and sets up the different actions a

### Set names

The post type labels and slugs are automatically generated from the post type name, however, if you can set these manually by passing an array of names to the post types constructor.
The post type labels and slugs are automatically generated from the post type name, however, you can set these manually by passing an array of names to the class constructor.

```php
$names = [
Expand All @@ -46,7 +46,7 @@ The following names are accepted.
| `plural` | is the plural label for the post type | e.g 'Books', 'People' |
| `slug` | is the post type slug used in the permalinks | plural, lowercase, hyphens |

The only required name is the post types `name`, all others are optional.
The only required field is the post type's `name`, all others are optional.

### Set options

Expand Down
2 changes: 1 addition & 1 deletion docs/taxonomies/Columns.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Columns

You can now modify a `Taxonomy` columns using the same methods as you would for a `PostType`. For example:
You can now modify `Taxonomy` columns using the same methods as you would for a `PostType`. For example:

```php
// Create a taxonomy
Expand Down
2 changes: 1 addition & 1 deletion docs/taxonomies/Create-a-taxonomy.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The following names are accepted.

#### Add options

You can further customise taxonomies by passing an array of options as the second argument to the method.
You can further customise taxonomies by passing an array of options as the second argument in the constructor.

```php
$options = [
Expand Down

0 comments on commit 16c5894

Please sign in to comment.