bueltge/wp-rest-api-filter-items

View on GitHub
CONTRIBUTING.md

Summary

Maintainability
Test Coverage
Thanks for contributing—you rock!

# WP REST API Filter Items
* For general information please refer to the [this repository](https://github.com/bueltge/WP-REST-API-Filter-Items).
* The plugin has to stay backwards compatible with the two versions prior to the current stable
version of WordPress.
* The plugin respects the [WordPress Coding
Standards](https://make.wordpress.org/core/handbook/coding-standards/) and follows additional [conventions and best
practices](https://github.com/inpsyde/Codex/blob/master/accepted/styleguide_conventions_bestpractices_EN.md). 

# Getting Started
* Make sure you have a [GitHub account](https://github.com/signup/free).
* See if your issue has been discussed (or even fixed) earlier. You can [search for existing
issues](https://github.com/bueltge/WP-REST-API-Filter-Items/issues?utf8=%E2%9C%93&q=is%3Aissue).
* Assuming it does not already exist, [create a new
issue](https://github.com/bueltge/WP-REST-API-Filter-Items/issues/new).
    * Clearly describe the issue including steps to reproduce when it is a bug.
    * Make sure you fill in the earliest version that you know has the issue.
* Fork the repository on GitHub.

# Making Changes
* Create a topic branch from where you want to base your work.
    * This is usually the `master` branch.
    * Only target release branches if you are certain your fix must be on that branch.
    * To quickly create a topic branch based on the `master` branch:
        * `git checkout -b issue/%YOUR-ISSUE-NUMBER%_%DESCRIPTIVE-TITLE% master`
        * a good example is `issue/123_typo_in_foo`
    * Please avoid working directly on the `master` branch.
* Make commits of logical units.
* Make sure your commit messages are helpful.

# Submitting Changes
* Push your changes to the according topic branch in your fork of the repository.
* [Create a pull request](https://github.com/bueltge/WP-REST-API-Filter-Items/compare) to our repository.
* Wait for feedback. Our team looks at pull requests on a regular basis.

# License
By contributing code to this plugin, you grant its use under the [GNU General Public License
v3](LICENSE).