33♥ [ HTML5 Boilerplate] ( http://html5boilerplate.com ) and want to get involved?
44Thanks! There are plenty of ways you can help!
55
6+ Please take a moment to review this document in order to make the contribution
7+ process easy and effective for everyone involved.
68
7- ## Bugs
9+ Following these guidelines helps to communicate that you respect the time of
10+ the developers managing and developing this open source project. In return,
11+ they should reciprocate that respect in addressing your issue or assessing
12+ patches and features.
813
9- A bug is a _ demonstrable problem_ that is caused by the code in the
10- repository. Good bug reports are extremely helpful - thank you!
14+
15+ ## Using the issue tracker
16+
17+ The [ issue tracker] ( https://github.com/h5bp/html5-boilerplate/issues ) is
18+ the preferred channel for [ bug reports] ( #bugs ) , [ features requests] ( #features )
19+ and [ submitting pull requests] ( #pull-requests ) , but please respect the following
20+ restrictions:
21+
22+ * Please ** do not** use the issue tracker for personal support requests (use
23+ [ Stack Overflow] ( http://stackoverflow.com/questions/tagged/html5boilerplate )
24+ or IRC).
25+
26+ * Please ** do not** derail or troll issues. Keep the discussion on topic and
27+ respect the opinions of others.
28+
29+ * Please ** do not** open issues or pull requests regarding the code in
30+ [ ` .htaccess ` ] ( https://github.com/h5bp/server-configs-apache ) ,
31+ [ ` jQuery ` ] ( https://github.com/jquery/jquery/ ) ,
32+ [ ` Modernizr ` ] ( https://github.com/Modernizr/Modernizr ) or
33+ [ ` Normalize.css ` ] ( https://github.com/necolas/normalize.css ) (open them in
34+ their respective repositories).
35+
36+
37+ <a name =" bugs " ></a >
38+ ## Bug reports
39+
40+ A bug is a _ demonstrable problem_ that is caused by the code in the repository.
41+ Good bug reports are extremely helpful - thank you!
1142
1243Guidelines for bug reports:
1344
14451 . ** Use the GitHub issue search** &mdash ; check if the issue has already been
1546 reported.
1647
17482 . ** Check if the issue has been fixed** &mdash ; try to reproduce it using the
18- latest ` master ` branch in the repository.
49+ latest ` master ` or development branch in the repository.
1950
20513 . ** Isolate the problem** &mdash ; ideally create a [ reduced test
2152 case] ( http://css-tricks.com/6263-reduced-test-cases/ ) and a live example.
@@ -37,39 +68,50 @@ Example:
3768> 2 . This is the second step
3869> 3 . Further steps, etc.
3970>
40- > ` <url> ` ( a link to the reduced test case)
71+ > ` <url> ` - a link to the reduced test case
4172>
4273> Any other information you want to share that is relevant to the issue being
4374> reported. This might include the lines of code that you have identified as
4475> causing the bug, and potential solutions (and your opinions on their
4576> merits).
4677
47- ** [ File a bug report] ( https://github.com/h5bp/html5-boilerplate/issues/ ) **
4878
79+ <a name =" features " ></a >
80+ ## Feature requests
81+
82+ Feature requests are welcome. But take a moment to find out whether your idea
83+ fits with the scope and aims of the project. It's up to * you* to make a strong
84+ case to convince the project's developers of the merits of this feature. Please
85+ provide as much detail and context as possible.
4986
87+
88+ <a name =" pull-requests " ></a >
5089## Pull requests
5190
5291Good pull requests - patches, improvements, new features - are a fantastic
5392help. They should remain focused in scope and avoid containing unrelated
54- commits. If your contribution involves a significant amount of work or substantial
55- changes to any part of the project, please open an issue to discuss it first.
93+ commits.
94+
95+ ** Please ask first** before embarking on any significant pull request (e.g.
96+ implementing features, refactoring code, porting to a different language),
97+ otherwise you risk spending a lot of time working on something that the
98+ project's developers might not want to merge into the project.
5699
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.
100+ Please adhere to the coding conventions used throughout a project (indentation,
101+ accurate comments, etc.) and any other requirements (such as test coverage).
60102
61- Please follow this process; it's the best way to get your work included in the
62- project:
103+ Adhering to the following this process is the best way to get your work
104+ included in the project:
63105
641061 . [ Fork] ( http://help.github.com/fork-a-repo/ ) the project, clone your fork,
65107 and configure the remotes:
66108
67109 ``` bash
68- # Clones your fork of the repo into the current directory in terminal
110+ # Clone your fork of the repo into the current directory
69111 git clone https://github.com/< your-username> /html5-boilerplate.git
70112 # Navigate to the newly cloned directory
71113 cd html5-boilerplate
72- # Assigns the original repo to a remote called "upstream"
114+ # Assign the original repo to a remote called "upstream"
73115 git remote add upstream https://github.com/h5bp/html5-boilerplate.git
74116 ```
75117
@@ -80,16 +122,16 @@ project:
80122 git pull upstream master
81123 ```
82124
83- 3 . Create a new topic branch to contain your feature, change, or fix:
125+ 3 . Create a new topic branch (off the main project development branch) to
126+ contain your feature, change, or fix:
84127
85128 ``` bash
86129 git checkout -b < topic-branch-name>
87130 ```
88131
891324 . Commit your changes in logical chunks. Please adhere to these [ git commit
90- message
91- guidelines] ( http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html )
92- or your pull request is unlikely be merged into the main project. Use git's
133+ message guidelines] ( http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html )
134+ or your code is unlikely be merged into the main project. Use Git's
93135 [ interactive rebase] ( https://help.github.com/articles/interactive-rebase )
94136 feature to tidy up your commits before making them public.
95137
@@ -105,14 +147,8 @@ project:
105147 git push origin < topic-branch-name>
106148 ```
107149
108- 10 . [ Open a Pull Request] ( https://help.github.com/articles/using-pull-requests ) with a
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).
150+ 7 . [ Open a Pull Request] ( https://help.github.com/articles/using-pull-requests/ )
151+ with a clear title and description.
116152
117- Please ** do not ** derail or troll issues. Keep the
118- discussion on topic and respect the opinions of others .
153+ ** IMPORTANT ** : By submitting a patch, you agree to allow the project owners to
154+ license your work under the the terms of the [ MIT License ] ( LICENSE.md ) .
0 commit comments