1
- # Contributing to HTML5 Boilerplate
2
-
3
- ♥ [ HTML5 Boilerplate] ( https://html5boilerplate.com/ ) and want to get involved?
4
- Thanks! We're actively looking for folks interested in helping out and there
5
- are plenty of ways you can help!
1
+ # Contributing to Create HTML5 Boilerplate
6
2
7
3
Please take a moment to review this document in order to make the contribution
8
4
process easy and effective for everyone involved.
@@ -12,29 +8,19 @@ the developers managing and developing this open source project. In return,
12
8
they should reciprocate that respect in addressing your issue or assessing
13
9
patches and features.
14
10
15
-
16
11
## Using the issue tracker
17
12
18
- The [ issue tracker] ( https://github.com/h5bp/html5-boilerplate/issues ) is
13
+ The [ issue tracker] ( https://github.com/h5bp/create- html5-boilerplate/issues ) is
19
14
the preferred channel for [ bug reports] ( #bugs ) , [ features requests] ( #features )
20
15
and [ submitting pull requests] ( #pull-requests ) , but please respect the following
21
16
restrictions:
22
17
23
- * Please ** do not** use the issue tracker for personal support requests (use
18
+ - Please ** do not** use the issue tracker for personal support requests (use
24
19
[ Stack Overflow] ( https://stackoverflow.com/questions/tagged/html5boilerplate ) ).
25
20
26
- * Please ** do not** derail or troll issues. Keep the discussion on topic and
21
+ - Please ** do not** derail or troll issues. Keep the discussion on topic and
27
22
respect the opinions of others.
28
23
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
24
## Bug reports
39
25
40
26
A bug is a _ demonstrable problem_ that is caused by the code in the repository.
@@ -75,17 +61,13 @@ Example:
75
61
> causing the bug, and potential solutions (and your opinions on their
76
62
> merits).
77
63
78
-
79
- <a name =" features " ></a >
80
64
## Feature requests
81
65
82
66
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
67
+ fits with the scope and aims of the project. It's up to _ you _ to make a strong
84
68
case to convince the project's developers of the merits of this feature. Please
85
69
provide as much detail and context as possible.
86
70
87
-
88
- <a name =" pull-requests " ></a >
89
71
## Pull requests
90
72
91
73
Good pull requests - patches, improvements, new features - are a fantastic
@@ -100,55 +82,5 @@ project's developers might not want to merge into the project.
100
82
Please adhere to the coding conventions used throughout a project (indentation,
101
83
accurate comments, etc.) and any other requirements (such as test coverage).
102
84
103
- Adhering to the following process is the best way to get your work
104
- included in the project:
105
-
106
- 1 . [ Fork] ( https://help.github.com/articles/fork-a-repo/ ) the project, clone your
107
- fork, and configure the remotes:
108
-
109
- ``` bash
110
- # Clone your fork of the repo into the current directory
111
- git clone https://github.com/< your-username> /html5-boilerplate.git
112
- # Navigate to the newly cloned directory
113
- cd html5-boilerplate
114
- # Assign the original repo to a remote called "upstream"
115
- git remote add upstream https://github.com/h5bp/html5-boilerplate.git
116
- ```
117
-
118
- 2 . If you cloned a while ago, get the latest changes from upstream:
119
-
120
- ``` bash
121
- git checkout master
122
- git pull upstream master
123
- ```
124
-
125
- 3 . Create a new topic branch (off the main project development branch) to
126
- contain your feature, change, or fix:
127
-
128
- ``` bash
129
- git checkout -b < topic-branch-name>
130
- ```
131
-
132
- 4 . Commit your changes in logical chunks. Please adhere to these [ git commit
133
- message guidelines] ( https://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
135
- [ interactive rebase] ( https://help.github.com/articles/about-git-rebase/ )
136
- feature to tidy up your commits before making them public.
137
-
138
- 5 . Locally merge (or rebase) the upstream development branch into your topic branch:
139
-
140
- ``` bash
141
- git pull [--rebase] upstream master
142
- ```
143
-
144
- 6 . Push your topic branch up to your fork:
145
-
146
- ``` bash
147
- git push origin < topic-branch-name>
148
- ```
149
-
150
- 7 . [ Open a Pull Request] ( https://help.github.com/articles/using-pull-requests/ )
151
- with a clear title and description.
152
-
153
85
** IMPORTANT** : By submitting a patch, you agree to allow the project
154
86
owners to license your work under the terms of the [ MIT License] ( LICENSE.txt ) .
0 commit comments