| @@ -1,22 +1,73 @@ | ||
| 1 | -# Contributing to this project | |
| 1 | +# Contribute to Stream | |
| 2 | 2 | |
| 3 | -Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved. | |
| 4 | 3 | |
| 5 | -Following these guidelines will help us get back to you more quickly, and will show that you care about making Stream better just like we do. In return, we'll do our best to respond to your issue or pull request as soon as possible with the same respect. | |
| 4 | +## Development Environment | |
| 6 | 5 | |
| 6 | +Stream uses [npm](https://npmjs.com) for javascript dependencies, [Composer](https://getcomposer.org) for PHP dependencies and the [Grunt](https://gruntjs.com) task runner to minimize and compile scripts and styles and to deploy to the WordPress.org plugin repository. | |
| 7 | 7 | |
| 8 | -## Use the issue tracker | |
| 8 | +Included is a local development environment built with [Docker](https://www.docker.com) which can be optionally run inside [Vagrant](https://www.vagrantup.com) for network isolation and better performance. | |
| 9 | 9 | |
| 10 | -The [issue tracker](https://github.com/wp-stream/stream/issues) is the preferred channel for [bug reports](#bugs), [features requests](#features) and [submitting pull requests](#pull-requests), but please respect the following restrictions: | |
| 10 | +### Requirements | |
| 11 | 11 | |
| 12 | -* Support issues or usage questions that are not bugs should be posted on the [Plugin Support Forum](http://wordpress.org/support/plugin/stream). | |
| 13 | -* Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others. | |
| 12 | +- [VirtualBox](https://www.virtualbox.org) | |
| 13 | +- [Vagrant](https://www.vagrantup.com) | |
| 14 | +- [Node.js](https://nodejs.org) | |
| 15 | +- [Composer](https://getcomposer.org) | |
| 14 | 16 | |
| 17 | +We suggest using the [Homebrew package manager](https://brew.sh) on macOS to install the dependencies: | |
| 15 | 18 | |
| 19 | + brew install node composer | |
| 20 | + brew cask install virtualbox vagrant | |
| 21 | + | |
| 22 | +For setups with local Docker environment you don't need Vagrant and VirtualBox. | |
| 23 | + | |
| 24 | +### Environment Setup | |
| 25 | + | |
| 26 | +1. See the [Git Flow](#git-flow) section below for how to fork the repository. | |
| 27 | +2. Run `npm install` to install all project dependencies. | |
| 28 | +3. Run `vagrant up` to start the development environment. | |
| 29 | +4. Visit [stream.local](http://stream.local) and login using `admin` / `password`. | |
| 30 | +5. Activate the Stream plugin. | |
| 31 | + | |
| 32 | +### PHP Xdebug | |
| 33 | + | |
| 34 | +The WordPress container includes the [Xdebug PHP extension](https://xdebug.org). It is configured to [autostart](https://xdebug.org/docs/remote#remote_autostart) and to [automatically detect the IP address of the connecting client](https://xdebug.org/docs/remote#remote_connect_back) running in your code editor. See [`.vscode/launch.json`](.vscode/launch.json) for the directory mapping from the WordPress container to the project directory in your code editor. | |
| 35 | + | |
| 36 | +### Mail Catcher | |
| 37 | + | |
| 38 | +We use a [MailHog](https://github.com/mailhog/MailHog) container to capture all emails sent by the WordPress container, available at [stream.local:8025](https://stream.local:8025). | |
| 39 | + | |
| 40 | +### Scripts and Commands | |
| 41 | + | |
| 42 | +We use npm as the canonical task runner for the project. The following commands are available: | |
| 43 | + | |
| 44 | +- `npm run build` to build the plugin JS and CSS files. | |
| 45 | + | |
| 46 | +- `npm run lint` to check JS and PHP files for syntax and style issues. | |
| 47 | + | |
| 48 | +- `npm run deploy` to deploy the plugin to the WordPress.org repository. | |
| 49 | + | |
| 50 | +- `npm run cli -- wp info` where `wp info` is the CLI command to run inside the WordPress container. For example, use `npm run cli -- ls -lah` to list all files in the root of the WordPress installation. | |
| 51 | + | |
| 52 | +- `npm run compose -- up -d` where `up -d` is the `docker-compose` command for the WordPress container. For example, use `npm run compose -- down` and `npm run compose -- up -d` to restart the WordPres container. | |
| 53 | + | |
| 54 | +- `npm run phpunit` to run PHPunit tests inside the WordPress container. | |
| 55 | + | |
| 56 | +All `npm` commands running inside Vagrant are prefixed with `v`, for example, `npm run vcli` and `npm run vcompose`. | |
| 57 | + | |
| 58 | + | |
| 59 | +## Issues Tracker | |
| 60 | + | |
| 61 | +Support issues or usage questions should be posted on the [Plugin Support Forum](https://wordpress.org/support/plugin/stream). | |
| 62 | + | |
| 63 | +The [issue tracker on GitHub](https://github.com/xwp/stream/issues) is the preferred channel for [bug reports](#bugs), [features requests](#features) and [submitting pull requests](#pull-requests). | |
| 64 | + | |
| 65 | + | |
| 16 | 66 | <a name="bugs"></a> |
| 17 | -## Bug reports | |
| 18 | 67 | |
| 68 | +## Reporting Bugs | |
| 69 | + | |
| 19 | 70 | A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports with complete error messages, environment details and screenshots are extremely helpful — thank you! |
| 20 | 71 | |
| 21 | 72 | Guidelines for bug reports: |
| 22 | 73 | |
| @@ -21,9 +72,9 @@ | ||
| 21 | 72 | Guidelines for bug reports: |
| 22 | 73 | |
| 23 | 74 | 1. **Check if the bug has already been fixed** — Someone may already be on top of it, so try to reproduce it using the latest from the `master` branch. |
| 24 | 75 | |
| 25 | -2. **Use the [GitHub issue search](https://github.com/wp-stream/stream/search?type=Issues)** — Someone might already know about it, so please check if the issue has already been reported. | |
| 76 | +2. **Use the [GitHub issue search](https://github.com/xwp/stream/search?type=Issues)** — Someone might already know about it, so please check if the issue has already been reported. | |
| 26 | 77 | |
| 27 | 78 | 3. **Isolate the problem** — The better you can determine exactly what behavior(s) cause the issue, the faster and more effectively it can be resolved. “I’m getting an error message.” is not a good bug report. A good bug report shouldn't leave others needing to contact you for more information. |
| 28 | 79 | |
| 29 | 80 | Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) experience the problem? What outcome did you expect, and how did it differ from what you actually saw? All these details will help people to fix any potential bugs. |
| @@ -42,30 +93,36 @@ | ||
| 42 | 93 | > Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits). |
| 43 | 94 | |
| 44 | 95 | **Note:** In an effort to keep open issues to a manageable number, we will close any issues that do not provide enough information for us to be able to work on a solution. You will be encouraged to provide the necessary details, after which we will reopen the issue. |
| 45 | 96 | |
| 97 | + | |
| 46 | 98 | <a name="features"></a> |
| 47 | -## Feature requests | |
| 48 | 99 | |
| 100 | +## Feature Requests | |
| 101 | + | |
| 49 | 102 | Feature requests are very welcome! But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to *you* to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible. |
| 50 | 103 | |
| 51 | 104 | Building something great means choosing features carefully especially because it is much, much easier to add features than it is to take them away. Additions to Stream will be evaluated on a combination of scope (how well it fits into the project), maintenance burden and general usefulness to users. |
| 52 | 105 | |
| 106 | + | |
| 53 | 107 | <a name="pull-requests"></a> |
| 54 | -## Pull requests | |
| 55 | 108 | |
| 109 | +## Pull Requests | |
| 110 | + | |
| 56 | 111 | Good pull requests — patches, improvements, new features — are a fantastic help. |
| 57 | 112 | They should remain focused in scope and avoid containing unrelated commits. |
| 58 | 113 | |
| 59 | -**Please ask first** before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project. You can solicit feedback and opinions in an open enhancement issue, or [create a new one](https://github.com/wp-stream/stream/issues/new). | |
| 114 | +**Please ask first** before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project. You can solicit feedback and opinions in an open enhancement issue, or [create a new one](https://github.com/xwp/stream/issues/new). | |
| 60 | 115 | |
| 61 | -Please use the [git flow for pull requests](#git-flow) and follow [WordPress Coding Standards](http://make.wordpress.org/core/handbook/coding-standards/) before submitting your work. Adhering to these guidelines is the best way to get your work included in Stream. | |
| 116 | +Please use the [git flow for pull requests](#git-flow) and follow [WordPress Coding Standards](https://make.wordpress.org/core/handbook/coding-standards/) before submitting your work. | |
| 62 | 117 | |
| 118 | + | |
| 63 | 119 | <a name="git-flow"></a> |
| 64 | -#### Git Flow for pull requests | |
| 65 | 120 | |
| 66 | -1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, and configure the remotes: | |
| 121 | +### Git Flow for Pull Requests | |
| 67 | 122 | |
| 123 | +1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork, and configure the remotes: | |
| 124 | + | |
| 68 | 125 | ```bash |
| 69 | 126 | # Clone your fork of the repo into the current directory |
| 70 | 127 | git clone [email protected]:<YOUR_USERNAME>/stream.git |
| 71 | 128 | # Navigate to the newly cloned directory |
| @@ -70,9 +127,9 @@ | ||
| 70 | 127 | git clone [email protected]:<YOUR_USERNAME>/stream.git |
| 71 | 128 | # Navigate to the newly cloned directory |
| 72 | 129 | cd stream |
| 73 | 130 | # Assign the original repo to a remote called "upstream" |
| 74 | - git remote add upstream https://github.com/wp-stream/stream | |
| 131 | + git remote add upstream https://github.com/xwp/stream | |
| 75 | 132 | ``` |
| 76 | 133 | |
| 77 | 134 | 2. If you cloned a while ago, get the latest changes from upstream: |
| 78 | 135 | |
| @@ -86,9 +143,9 @@ | ||
| 86 | 143 | ```bash |
| 87 | 144 | git checkout -b <topic-branch-name> |
| 88 | 145 | ``` |
| 89 | 146 | |
| 90 | -4. Commit your changes in logical chunks. Please adhere to these [git commit message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) or your code is unlikely be merged into the main project. Use Git's [interactive rebase](https://help.github.com/articles/interactive-rebase) feature to tidy up your commits before making them public. | |
| 147 | +4. Commit your changes in logical chunks. Please adhere to these [git commit message guidelines](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). Use Git's [interactive rebase](https://help.github.com/articles/interactive-rebase) feature to tidy up your commits before making them public. | |
| 91 | 148 | |
| 92 | 149 | 5. Locally merge (or rebase) the upstream development branch into your topic branch: |
| 93 | 150 | |
| 94 | 151 | ```bash |
| @@ -102,5 +159,5 @@ | ||
| 102 | 159 | ``` |
| 103 | 160 | |
| 104 | 161 | 7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) (with a clear title and description) to the `develop` branch. |
| 105 | 162 | |
| 106 | -**IMPORTANT**: By submitting a patch, you agree to allow the project owner to license your work under the [GPL v2 license](http://www.gnu.org/licenses/gpl-2.0.html). | |
| 163 | +**IMPORTANT**: By submitting a patch, you agree to allow the project owner to license your work under the [GPL v2 license](https://www.gnu.org/licenses/gpl-2.0.html). | |
