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

Roots 6.5.0

Browse Source
This commit is contained in:
Ben Word
2013-08-22 22:17:35 -05:00
parent 59237e584c
commit d20aa0fe50
19 changed files with 160 additions and 656 deletions
Download Patch File Download Diff File Expand all files Collapse all files

139
CONTRIBUTING.md
View File

@@ -1,74 +1,121 @@
# Contributing to Roots Theme
## Reporting issues
Please take a moment to review this document in order to make the contribution
process easy and effective for everyone involved.
**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):
Following these guidelines helps to communicate that you respect the time of
the developers managing and developing this open source project. In return,
they should reciprocate that respect in addressing your issue or assessing
patches and features.
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.
2. **Isolate the problem to Roots.** Make sure that the code in the Roots
## Using the issue tracker
The issue tracker is the preferred channel for [bug reports](#bugs),
[features requests](#features) and [submitting pull
requests](#pull-requests), but please respect the following restrictions:
* Please **do not** use the issue tracker for personal support requests (use the
[Roots Discourse](http://discourse.roots.io/)).
* Please **do not** derail or troll issues. Keep the discussion on topic and
respect the opinions of others.
<a name="bugs"></a>
## Bug reports
A bug is a _demonstrable problem_ that is caused by the code in the repository.
Good bug reports are extremely helpful - thank you!
Guidelines for bug reports:
1. **Use the GitHub issue search** &mdash; check if the issue has already been
reported.
2. **Check if the issue has been fixed** &mdash; try to reproduce it using the
latest `master` or development branch in the repository.
3. **Isolate the problem to Roots** &mdash; 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.
theme (such as Twenty Thirteen) 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.
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).
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)**
A good bug report shouldn't leave others needing to chase you up for more
information. Please try to be as detailed as possible in your report.
<a name="features"></a>
## Feature requests
Feature requests are welcome. But take a moment to find out whether your idea
fits with the scope and aims of Roots. It's up to *you* to make a strong
case to convince the Roots developers of the merits of this feature. Please
provide as much detail and context as possible.
<a name="pull-requests"></a>
## Pull requests
Good pull requests — patches, improvements, new features — are a fantastic
Good pull requests - patches, improvements, new features - are a fantastic
help. They should remain focused in scope and avoid containing unrelated
commits.
If your contribution involves a significant amount of work or substantial
changes to any part of the project, please open an issue to discuss it first.
**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 developers might not want to merge into Roots.
Please follow this process; it's the best way to get your work included in the
project:
Please adhere to the coding conventions used throughout the project (indentation,
comments, etc.).
1. [Fork](https://help.github.com/articles/fork-a-repo) the project.
Adhering to the following this process is the best way to get your work
included in Roots:
2. Clone your fork (`git clone
https://github.com/<your-username>/roots.git`).
1. [Fork](http://help.github.com/fork-a-repo/) Roots, clone your fork,
and configure the remotes:
3. Add an `upstream` remote (`git remote add upstream
https://github.com/retlehs/roots.git`).
```bash
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/<repo-name>
# Navigate to the newly cloned directory
cd <repo-name>
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/<upsteam-owner>/<repo-name>
```
4. Get the latest changes from upstream (`git pull upstream
master`).
2. If you cloned a while ago, get the latest changes from upstream:
5. Create a new topic branch to contain your feature, change, or fix (`git
checkout -b <topic-branch-name>`).
```bash
git checkout <dev-branch>
git pull upstream <dev-branch>
```
6. Make sure that your changes adhere to the current coding conventions used
throughout the project - indentation, accurate comments, etc. Please update
any documentation that is relevant to the change you are making.
3. Create a new topic branch (off the main project development branch) to
contain your feature, change, or fix:
7. Commit your changes in logical chunks; use git's [interactive
rebase](https://help.github.com/articles/interactive-rebase) feature to tidy
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.
```bash
git checkout -b <topic-branch-name>
```
8. Locally merge (or rebase) the upstream branch into your topic branch.
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.
9. Push your topic branch up to your fork (`git push origin
<topic-branch-name>`).
5. Locally merge (or rebase) the upstream development branch into your topic branch:
10. [Open a Pull Request](https://help.github.com/articles/using-pull-requests) with a
clear title and description.
```bash
git pull [--rebase] upstream <dev-branch>
```
6. Push your topic branch up to your fork:
```bash
git push origin <topic-branch-name>
```
10. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
with a clear title and description.