Skip to content

Commit 0373c5b

Browse files
roblarsenroblarsen
authored
Merge pull request #6 from h5bp/dotgithub
stubbing out the .github folder
2 parents 361afb9 + 8751eca commit 0373c5b

File tree

6 files changed

+264
-0
lines changed

6 files changed

+264
-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: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Contributing to Create HTML5 Boilerplate
2+
3+
Please take a moment to review this document in order to make the contribution
4+
process easy and effective for everyone involved.
5+
6+
Following these guidelines helps to communicate that you respect the time of
7+
the developers managing and developing this open source project. In return,
8+
they should reciprocate that respect in addressing your issue or assessing
9+
patches and features.
10+
11+
## Using the issue tracker
12+
13+
The [issue tracker](https://github.com/h5bp/create-html5-boilerplate/issues) is
14+
the preferred channel for [bug reports](#bugs), [features requests](#features)
15+
and [submitting pull requests](#pull-requests), but please respect the following
16+
restrictions:
17+
18+
- Please **do not** use the issue tracker for personal support requests (use
19+
[Stack Overflow](https://stackoverflow.com/questions/tagged/html5boilerplate)).
20+
21+
- Please **do not** derail or troll issues. Keep the discussion on topic and
22+
respect the opinions of others.
23+
24+
## Bug reports
25+
26+
A bug is a _demonstrable problem_ that is caused by the code in the repository.
27+
Good bug reports are extremely helpful - thank you!
28+
29+
Guidelines for bug reports:
30+
31+
1. **Use the GitHub issue search** — check if the issue has already been
32+
reported.
33+
34+
2. **Check if the issue has been fixed** — try to reproduce it using the
35+
latest `master` or development branch in the repository.
36+
37+
3. **Isolate the problem** — ideally create a [reduced test
38+
case](https://css-tricks.com/reduced-test-cases/) and a live example.
39+
40+
A good bug report shouldn't leave others needing to chase you up for more
41+
information. Please try to be as detailed as possible in your report. What is
42+
your environment? What steps will reproduce the issue? What browser(s) and OS
43+
experience the problem? What would you expect to be the outcome? All these
44+
details will help people to fix any potential bugs.
45+
46+
Example:
47+
48+
> Short and descriptive example bug report title
49+
>
50+
> A summary of the issue and the browser/OS environment in which it occurs. If
51+
> suitable, include the steps required to reproduce the bug.
52+
>
53+
> 1. This is the first step
54+
> 2. This is the second step
55+
> 3. Further steps, etc.
56+
>
57+
> `<url>` - a link to the reduced test case
58+
>
59+
> Any other information you want to share that is relevant to the issue being
60+
> reported. This might include the lines of code that you have identified as
61+
> causing the bug, and potential solutions (and your opinions on their
62+
> merits).
63+
64+
## Feature requests
65+
66+
Feature requests are welcome. But take a moment to find out whether your idea
67+
fits with the scope and aims of the project. It's up to _you_ to make a strong
68+
case to convince the project's developers of the merits of this feature. Please
69+
provide as much detail and context as possible.
70+
71+
## Pull requests
72+
73+
Good pull requests - patches, improvements, new features - are a fantastic
74+
help. They should remain focused in scope and avoid containing unrelated
75+
commits.
76+
77+
**Please ask first** before embarking on any significant pull request (e.g.
78+
implementing features, refactoring code, porting to a different language),
79+
otherwise you risk spending a lot of time working on something that the
80+
project's developers might not want to merge into the project.
81+
82+
Please adhere to the coding conventions used throughout a project (indentation,
83+
accurate comments, etc.) and any other requirements (such as test coverage).
84+
85+
**IMPORTANT**: By submitting a patch, you agree to allow the project
86+
owners to license your work under the terms of the [MIT License](LICENSE.txt).

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
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+
## Feature requests
67+
68+
Feature requests are welcome. But take a moment to find out whether your idea
69+
fits with the scope and aims of the project. It's up to *you* to make a strong
70+
case to convince the project's developers of the merits of this feature. Please
71+
provide as much detail and context as possible.

‎.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)