framework/sage
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update contributing guidelines

Browse Source
This commit is contained in:
Ben Word
2013-02-11 14:30:08 -06:00
parent 1a7017c1a7
commit 596a0a7304
1 changed files with 24 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
CONTRIBUTING.md
View File

@@ -2,44 +2,28 @@
## Reporting issues
A bug is a _demonstrable problem_ that is caused by the code in the
repository.
**We only accept issues that are bug reports or feature requests.** Bugs must
be isolated and reproducible problems that we can fix within Roots. Please
read the following guidelines before [opening any issues](https://github.com/retlehs/roots/issues):
Please read the following guidelines for reporting bugs:
Please read the following guidelines before you [report an issue](https://github.com/retlehs/roots/issues):
1. **Use the GitHub issue search.** Check to see if the issue has already been
reported. If it has been, please comment on the existing issue. An existing
issue may also already have a fix available.
1. **Use the GitHub issue search** — check if the issue has already been
reported. If it has been, please comment on the existing issue.
2. **Isolate the problem to Roots.** Make sure that the code in the Roots
repository is _definitely_ responsible for the issue. Switch to a core WordPress
theme (such as Twenty Twelve) to confirm problems before reporting an issue.
Make sure you have reproduced the bug with all plugins disabled. Any issues
related to HTML5 Boilerplate or Bootstrap should be reported to their respected
repositories and follow their contributing guidelines.
2. **Check if the issue has been fixed** — the latest `master` or
development branch may already contain a fix.
3. **Do not use GitHub issues for questions or support.** If you have a question
or support request, please post on the [Google Group](http://groups.google.com/group/roots-theme).
3. **Isolate the problem to Roots** — make sure that the code in the
Roots repository is _definitely_ responsible for the issue. Switch to a default WordPress theme to confirm problems before reporting an issue. Any issues related to HTML5 Boilerplate or Bootstrap should be reported to their respected repositories.
Please try to be as detailed as possible in your report too. What is your
environment? What steps will reproduce the issue? What browser(s) and OS
experience the problem? What would you expect to be the outcome? All these
details will help people to assess and fix any potential bugs.
### Example of a good bug report:
> Short and descriptive title
>
> A summary of the issue and the server OS environment in which it occurs. If
> suitable, include the steps required to reproduce the bug.
>
> 1. This is the first step
> 2. This is the second step
> 3. 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).
A good bug report shouldn't leave people needing to chase you up to get further
information that is required to assess or fix the bug.
Please try to be as detailed as possible in your report. What steps will
reproduce the issue? What would you expect to be the outcome? All these details
will help people to assess and fix any potential bugs. A good bug report
shouldn't leave people needing to chase you up to get further information.
**[File a bug report](https://github.com/retlehs/roots/issues)**
@@ -56,7 +40,7 @@ changes to any part of the project, please open an issue to discuss it first.
Please follow this process; it's the best way to get your work included in the
project:
1. [Fork](http://help.github.com/fork-a-repo/) the project.
1. [Fork](https://help.github.com/articles/fork-a-repo) the project.
2. Clone your fork (`git clone
https://github.com/<your-username>/roots.git`).
@@ -64,8 +48,8 @@ project:
3. Add an `upstream` remote (`git remote add upstream
https://github.com/retlehs/roots.git`).
4. Get the latest changes from upstream (e.g. `git pull upstream
<dev-branch>`).
4. Get the latest changes from upstream (`git pull upstream
master`).
5. Create a new topic branch to contain your feature, change, or fix (`git
checkout -b <topic-branch-name>`).
@@ -79,12 +63,12 @@ project:
up your commits before making them public. Please adhere to these [git commit
message
guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
or your pull request is unlikely be merged into the main project.
or your pull request is unlikely be merged.
8. Locally merge (or rebase) the upstream branch into your topic branch.
9. Push your topic branch up to your fork (`git push origin
<topic-branch-name>`).
10. [Open a Pull Request](http://help.github.com/send-pull-requests/) with a
clear title and description. Please mention which browsers you tested in.
10. [Open a Pull Request](https://help.github.com/articles/using-pull-requests) with a
clear title and description.