Contributing to this project
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
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.
Grunt to minimize and compile scripts and styles.
If you want to use this development version, you'll need to install
Node.js. Alternately, you can set
define( 'SCRIPT_DEBUG', true ); in
wp-config.php to use the uncompressed versions of the scripts and styles.
To use the build process, install Node.js
Once installed, run
npm install. This will install
Grunt and build the scripts and styles.
grunt to recompile the files. You won't need to do this if you set
define( 'SCRIPT_DEBUG', true ); as it will use the source files.
Use the issue tracker
- Support issues or usage questions that are not bugs should be posted on the Plugin Support Forum.
- Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.
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!
Guidelines for bug reports:
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
Use the GitHub issue search — Someone might already know about it, so please check if the issue has already been reported.
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.
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.
Short and descriptive example bug report title
A summary of the issue and the environment/browser in which it occurs. If suitable, include the steps required to reproduce the bug.
- This is the first step
- This is the second step
- Further steps, etc.
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).
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.
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.
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.
Good pull requests — patches, improvements, new features — are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
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.
Git Flow for pull requests
Fork the project, clone your fork, and configure the remotes:
# Clone your fork of the repo into the current directory git clone firstname.lastname@example.org:<YOUR_USERNAME>/stream.git # Navigate to the newly cloned directory cd stream # Assign the original repo to a remote called "upstream" git remote add upstream https://github.com/wp-stream/stream
If you cloned a while ago, get the latest changes from upstream:
git checkout master git pull upstream master
Create a new topic branch (off the
masterbranch) to contain your feature, change, or fix:
git checkout -b <topic-branch-name>
Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.
Locally merge (or rebase) the upstream development branch into your topic branch:
git pull [--rebase] upstream master
Push your topic branch up to your fork:
git push origin <topic-branch-name>
Open a Pull Request (with a clear title and description) to the
IMPORTANT: By submitting a patch, you agree to allow the project owner to license your work under the GPL v2 license.