Skip to content

Commit 964c929

Browse files
committed
Improve copy in CONTRIBUTING.md
Reflect some of the recent changes in necolas/issue-guidelines that tidy up the language and simplify parts of the guidelines.
1 parent e9a471b commit 964c929

File tree

1 file changed

+63
-46
lines changed

1 file changed

+63
-46
lines changed

CONTRIBUTING.md

Lines changed: 63 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,31 @@
44
Thanks! There are plenty of ways you can help!
55

66

7-
## Reporting issues
7+
## Bugs
88

99
A bug is a _demonstrable problem_ that is caused by the code in the
10-
repository.
10+
repository. Good bug reports are extremely helpful - thank you!
1111

12-
Please read the following guidelines before you [report an issue](https://github.com/h5bp/html5-boilerplate/issues/):
12+
Guidelines for bug reports:
1313

1414
1. **Use the GitHub issue search** — check if the issue has already been
15-
reported. If it has been, please comment on the existing issue.
15+
reported.
1616

17-
2. **Check if the issue has been fixed** — the latest `master` or
18-
development branch may already contain a fix.
17+
2. **Check if the issue has been fixed** — try to reproduce it using the
18+
latest `master` branch in the repository.
1919

20-
3. **Isolate the demonstrable problem** — make sure that the code in the
21-
project's repository is _definitely_ responsible for the issue. Create a
22-
[reduced test case](http://css-tricks.com/6263-reduced-test-cases/) - an
23-
extremely simple and immediately viewable example of the issue.
20+
3. **Isolate the problem** — ideally create a [reduced test
21+
case](http://css-tricks.com/6263-reduced-test-cases/) and a live example.
2422

25-
4. **Include a live example** — provide a link to your reduced test case
26-
when appropriate (e.g. if the issue is related to (front-end technologies).
27-
Please use [jsFiddle](http://jsfiddle.net) to host examples.
28-
29-
Please try to be as detailed as possible in your report too. What is your
30-
environment? What steps will reproduce the issue? What browser(s) and OS
23+
A good bug report shouldn't leave others needing to chase you up for more
24+
information. Please try to be as detailed as possible in your report. What is
25+
your environment? What steps will reproduce the issue? What browser(s) and OS
3126
experience the problem? What would you expect to be the outcome? All these
32-
details will help people to assess and fix any potential bugs.
27+
details will help people to fix any potential bugs.
3328

34-
### Example of a good bug report:
29+
Example:
3530

36-
> Short and descriptive title
31+
> Short and descriptive example bug report title
3732
>
3833
> A summary of the issue and the browser/OS environment in which it occurs. If
3934
> suitable, include the steps required to reproduce the bug.
@@ -49,53 +44,75 @@ details will help people to assess and fix any potential bugs.
4944
> causing the bug, and potential solutions (and your opinions on their
5045
> merits).
5146
52-
A good bug report shouldn't leave people needing to chase you up to get further
53-
information that is required to assess or fix the bug.
54-
5547
**[File a bug report](https://github.com/h5bp/html5-boilerplate/issues/)**
5648

5749

5850
## Pull requests
5951

60-
Good pull requests patches, improvements, new features are a fantastic
52+
Good pull requests - patches, improvements, new features - are a fantastic
6153
help. They should remain focused in scope and avoid containing unrelated
62-
commits.
63-
64-
If your contribution involves a significant amount of work or substantial
54+
commits. If your contribution involves a significant amount of work or substantial
6555
changes to any part of the project, please open an issue to discuss it first.
6656

57+
Make sure to adhere to the coding conventions used throughout a project
58+
(indentation, accurate comments, etc.). Please update any documentation that is
59+
relevant to the change you're making.
60+
6761
Please follow this process; it's the best way to get your work included in the
6862
project:
6963

70-
1. [Fork](http://help.github.com/fork-a-repo/) the project.
64+
1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
65+
and configure the remotes:
7166

72-
2. Clone your fork (`git clone
73-
https://github.com/<your-username>/html5-boilerplate.git`).
67+
```bash
68+
# Clones your fork of the repo into the current directory in terminal
69+
git clone https://github.com/<your-username>/html5-boilerplate.git
70+
# Navigate to the newly cloned directory
71+
cd html5-boilerplate
72+
# Assigns the original repo to a remote called "upstream"
73+
git remote add upstream https://github.com/h5bp/html5-boilerplate.git
74+
```
7475

75-
3. Add an `upstream` remote (`git remote add upstream
76-
https://github.com/h5bp/html5-boilerplate.git`).
76+
2. If you cloned a while ago, get the latest changes from upstream:
7777

78-
4. Get the latest changes from upstream (e.g. `git pull upstream
79-
<dev-branch>`).
78+
```bash
79+
git checkout master
80+
git pull upstream master
81+
```
8082

81-
5. Create a new topic branch to contain your feature, change, or fix (`git
82-
checkout -b <topic-branch-name>`).
83+
3. Create a new topic branch to contain your feature, change, or fix:
8384

84-
6. Make sure that your changes adhere to the current coding conventions used
85-
throughout the project - indentation, accurate comments, etc. Please update
86-
any documentation that is relevant to the change you are making.
85+
```bash
86+
git checkout -b <topic-branch-name>
87+
```
8788

88-
7. Commit your changes in logical chunks; use git's [interactive
89-
rebase](https://help.github.com/articles/interactive-rebase) feature to tidy
90-
up your commits before making them public. Please adhere to these [git commit
89+
4. Commit your changes in logical chunks. Please adhere to these [git commit
9190
message
9291
guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
93-
or your pull request is unlikely be merged into the main project.
92+
or your pull request is unlikely be merged into the main project. Use git's
93+
[interactive rebase](https://help.github.com/articles/interactive-rebase)
94+
feature to tidy up your commits before making them public.
95+
96+
5. Locally merge (or rebase) the upstream development branch into your topic branch:
9497

95-
8. Locally merge (or rebase) the upstream branch into your topic branch.
98+
```bash
99+
git pull [--rebase] upstream master
100+
```
96101

97-
9. Push your topic branch up to your fork (`git push origin
98-
<topic-branch-name>`).
102+
6. Push your topic branch up to your fork:
103+
104+
```bash
105+
git push origin <topic-branch-name>
106+
```
99107

100108
10. [Open a Pull Request](http://help.github.com/send-pull-requests/) with a
101-
clear title and description. Please mention which browsers you tested in.
109+
clear title and description.
110+
111+
112+
## Do not…
113+
114+
Please **do not** use the issue tracker for personal support requests (use
115+
[StackOverflow](http://stackoverflow.com/questions/tagged/html5boilerplate) or IRC).
116+
117+
Please **do not** derail or troll issues. Keep the
118+
discussion on topic and respect the opinions of others.

0 commit comments

Comments
 (0)