Skip to content


Subversion checkout URL

You can clone with
Download ZIP
100644 102 lines (72 sloc) 3.97 KB
1e3be18 @necolas Rewrite documentation and add to repo
necolas authored
1 # Contributing to HTML5 Boilerplate
2c079ae @necolas Add a `` file
necolas authored
3 ♥ [HTML5 Boilerplate]( and want to get involved?
4 Thanks! There are plenty of ways you can help!
1e3be18 @necolas Rewrite documentation and add to repo
necolas authored
7 ## Reporting issues
9 A bug is a _demonstrable problem_ that is caused by the code in the
10 repository.
19c8065 @necolas Small adjustments to documentation
necolas authored
12 Please read the following guidelines before you [report an issue](
1e3be18 @necolas Rewrite documentation and add to repo
necolas authored
14 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.
17 2. **Check if the issue has been fixed** — the latest `master` or
18 development branch may already contain a fix.
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]( - an
23 extremely simple and immediately viewable example of the issue.
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]( to host examples.
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
31 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.
34 ### Example of a good bug report:
36 > Short and descriptive title
37 >
38 > A summary of the issue and the browser/OS environment in which it occurs. If
39 > suitable, include the steps required to reproduce the bug.
40 >
41 > 1. This is the first step
42 > 2. This is the second step
43 > 3. Further steps, etc.
44 >
45 > `<url>` (a link to the reduced test case)
46 >
47 > Any other information you want to share that is relevant to the issue being
48 > reported. This might include the lines of code that you have identified as
49 > causing the bug, and potential solutions (and your opinions on their
50 > merits).
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.
19c8065 @necolas Small adjustments to documentation
necolas authored
55 **[File a bug report](**
1e3be18 @necolas Rewrite documentation and add to repo
necolas authored
39a1801 Adding a link to Issue Tracker in Reporting Issues section
Divya Manian authored
1e3be18 @necolas Rewrite documentation and add to repo
necolas authored
58 ## Pull requests
60 Good pull requests — patches, improvements, new features — are a fantastic
61 help. They should remain focused in scope and avoid containing unrelated
62 commits.
64 If your contribution involves a significant amount of work or substantial
65 changes to any part of the project, please open an issue to discuss it first.
67 Please follow this process; it's the best way to get your work included in the
68 project:
70 1. [Fork]( the project.
72 2. Clone your fork (`git clone
75 3. Add an `upstream` remote (`git remote add upstream
78 4. Get the latest changes from upstream (e.g. `git pull upstream
79 <dev-branch>`).
81 5. Create a new topic branch to contain your feature, change, or fix (`git
82 checkout -b <topic-branch-name>`).
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.
88 7. Commit your changes in logical chunks; use git's [interactive
89 rebase]( feature to tidy
90 up your commits before making them public. Please adhere to these [git commit
91 message
92 guidelines](
93 or your pull request is unlikely be merged into the main project.
95 8. Locally merge (or rebase) the upstream branch into your topic branch.
97 9. Push your topic branch up to your fork (`git push origin
98 <topic-branch-name>`).
100 10. [Open a Pull Request]( with a
101 clear title and description. Please mention which browsers you tested in.
Something went wrong with that request. Please try again.