Skip to content

Commit 489de85

Browse files
roblarsenroblarsen
committed
stubbing out the .github folder
First commit for this stuff, literally just copied from the main project (which might be fine for now?) Touches on #2 and #1
1 parent 20584db commit 489de85

File tree

6 files changed

+335
-0
lines changed

6 files changed

+335
-0
lines changed

‎.github/CODE_OF_CONDUCT.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: https://contributor-covenant.org
46+
[version]: https://contributor-covenant.org/version/1/4/

‎.github/CONTRIBUTING.md

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
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!
6+
7+
Please take a moment to review this document in order to make the contribution
8+
process easy and effective for everyone involved.
9+
10+
Following these guidelines helps to communicate that you respect the time of
11+
the developers managing and developing this open source project. In return,
12+
they should reciprocate that respect in addressing your issue or assessing
13+
patches and features.
14+
15+
16+
## Using the issue tracker
17+
18+
The [issue tracker](https://github.com/h5bp/html5-boilerplate/issues) is
19+
the preferred channel for [bug reports](#bugs), [features requests](#features)
20+
and [submitting pull requests](#pull-requests), but please respect the following
21+
restrictions:
22+
23+
* Please **do not** use the issue tracker for personal support requests (use
24+
[Stack Overflow](https://stackoverflow.com/questions/tagged/html5boilerplate)).
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!
42+
43+
Guidelines for bug reports:
44+
45+
1. **Use the GitHub issue search** &mdash; check if the issue has already been
46+
reported.
47+
48+
2. **Check if the issue has been fixed** &mdash; try to reproduce it using the
49+
latest `master` or development branch in the repository.
50+
51+
3. **Isolate the problem** &mdash; ideally create a [reduced test
52+
case](https://css-tricks.com/reduced-test-cases/) and a live example.
53+
54+
A good bug report shouldn't leave others needing to chase you up for more
55+
information. Please try to be as detailed as possible in your report. What is
56+
your environment? What steps will reproduce the issue? What browser(s) and OS
57+
experience the problem? What would you expect to be the outcome? All these
58+
details will help people to fix any potential bugs.
59+
60+
Example:
61+
62+
> Short and descriptive example bug report title
63+
>
64+
> A summary of the issue and the browser/OS environment in which it occurs. If
65+
> suitable, include the steps required to reproduce the bug.
66+
>
67+
> 1. This is the first step
68+
> 2. This is the second step
69+
> 3. Further steps, etc.
70+
>
71+
> `<url>` - a link to the reduced test case
72+
>
73+
> Any other information you want to share that is relevant to the issue being
74+
> reported. This might include the lines of code that you have identified as
75+
> causing the bug, and potential solutions (and your opinions on their
76+
> merits).
77+
78+
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.
86+
87+
88+
<a name="pull-requests"></a>
89+
## Pull requests
90+
91+
Good pull requests - patches, improvements, new features - are a fantastic
92+
help. They should remain focused in scope and avoid containing unrelated
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.
99+
100+
Please adhere to the coding conventions used throughout a project (indentation,
101+
accurate comments, etc.) and any other requirements (such as test coverage).
102+
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+
**IMPORTANT**: By submitting a patch, you agree to allow the project
154+
owners to license your work under the terms of the [MIT License](LICENSE.txt).

‎.github/ISSUE_TEMPLATE.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
**I'm submitting a ...**
2+
<!-- (check one with "x") -->
3+
- [ ] bug report
4+
- [ ] feature request
5+
- [ ] other (Please do not submit support requests here (below))
6+
7+
## Notes:
8+
9+
* Please **do not** use the issue tracker for personal support requests (use
10+
[Stack Overflow](https://stackoverflow.com/questions/tagged/html5boilerplate)).
11+
12+
* Please **do not** derail or troll issues. Keep the discussion on topic and
13+
respect the opinions of others.
14+
15+
* Please **do not** open issues or pull requests regarding the code in
16+
[`.htaccess`](https://github.com/h5bp/server-configs-apache),
17+
[`jQuery`](https://github.com/jquery/jquery/),
18+
[`Modernizr`](https://github.com/Modernizr/Modernizr) or
19+
[`Normalize.css`](https://github.com/necolas/normalize.css) (open them in
20+
their respective repositories).
21+
22+
## Bug reports
23+
24+
A bug is a _demonstrable problem_ that is caused by the code in the repository.
25+
Good bug reports are extremely helpful - thank you!
26+
27+
Guidelines for bug reports:
28+
29+
1. **Use the GitHub issue search** &mdash; check if the issue has already been
30+
reported.
31+
32+
We have a long history of sometimes _very_ detailed discussion of every line of code
33+
in the project. We want discussion, so it might still warrant an issue. It
34+
just helps to get the (sometimes extensive) context.
35+
36+
2. **Check if the issue has been fixed** &mdash; try to reproduce it using the
37+
latest `master` or development branch in the repository.
38+
39+
3. **Isolate the problem** &mdash; ideally create a [reduced test
40+
case](https://css-tricks.com/reduced-test-cases/) and a live example.
41+
42+
A good bug report shouldn't leave others needing to chase you up for more
43+
information. Please try to be as detailed as possible in your report. What is
44+
your environment? What steps will reproduce the issue? What browser(s) and OS
45+
experience the problem? What would you expect to be the outcome? All these
46+
details will help people to fix any potential bugs.
47+
48+
Example:
49+
50+
> Short and descriptive example bug report title
51+
>
52+
> A summary of the issue and the browser/OS environment in which it occurs. If
53+
> suitable, include the steps required to reproduce the bug.
54+
>
55+
> 1. This is the first step
56+
> 2. This is the second step
57+
> 3. Further steps, etc.
58+
>
59+
> `<url>` - a link to the reduced test case
60+
>
61+
> Any other information you want to share that is relevant to the issue being
62+
> reported. This might include the lines of code that you have identified as
63+
> causing the bug, and potential solutions (and your opinions on their
64+
> merits).
65+
66+
67+
## Feature requests
68+
69+
Feature requests are welcome. But take a moment to find out whether your idea
70+
fits with the scope and aims of the project. It's up to *you* to make a strong
71+
case to convince the project's developers of the merits of this feature. Please
72+
provide as much detail and context as possible.
73+
74+

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## Types of changes
2+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
3+
- [ ] Bug fix (non-breaking change which fixes an issue)
4+
- [ ] New feature (non-breaking change which adds functionality)
5+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
6+
7+
## Checklist:
8+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
9+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
10+
- [ ] My code follows the code style of this project.
11+
- [ ] My change requires a change to the documentation.
12+
- [ ] I have updated the documentation accordingly.
13+
- [ ] I have read the **CONTRIBUTING** document.
14+
- [ ] I have added tests to cover my changes.
15+
- [ ] All new and existing tests passed.
16+
17+
Pull requests should be thought of as a conversation. There will be some back and forth when trying to get code merged into this or any other project. With all but the simplest changes you can and should expect that the maintainers of the project will request changes to your code. Please be aware of that and check in after you open your PR in order to get your code merged in cleanly.
18+
19+
Thanks!

‎.github/SUPPORT.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Support
2+
3+
For personal support requests with HTML5 Boilerplate please use Stack Overflow
4+
([`html5boilerplate`](https://stackoverflow.com/questions/tagged/html5boilerplate) tag).
5+
6+
Please check the respective repository/website for support regarding the code in
7+
[`.htaccess`](https://github.com/h5bp/server-configs-apache),
8+
[`jQuery`](https://jquery.org/support/),
9+
[`Modernizr`](https://modernizr.com/) or
10+
[`Normalize.css`](https://github.com/necolas/normalize.css).

‎.github/workflows/npmpublish.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: publish npm
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v1
12+
- uses: actions/setup-node@v1
13+
with:
14+
node-version: 12
15+
- run: npm ci
16+
- run: npm run build
17+
18+
publish-npm:
19+
needs: build
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v1
23+
- uses: actions/setup-node@v1
24+
with:
25+
node-version: 12
26+
registry-url: https://registry.npmjs.org/
27+
- run: npm ci
28+
- run: npm publish
29+
env:
30+
NODE_AUTH_TOKEN: ${{secrets.npm_token}}
31+
32+

0 commit comments

Comments
 (0)