Skip to content

Commit 0501162

Browse files
iamturnsiamturns
authored
feat: more docs and github templates (#21)
1 parent acc1aad commit 0501162

20 files changed

+522
-18
lines changed

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
assignees: @iamturns
3+
---
4+
5+
<!--
6+
Thanks for being willing to contribute!
7+
First step: provide a general summary of the issue in the Title above
8+
-->
9+
10+
**Checklist**
11+
12+
<!-- Put an x in the boxes that apply: [X]. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! -->
13+
14+
- [ ] Following [CODE_OF_CONDUCT.md](https://github.com/iamturns/create-exposed-app/blob/master/CODE_OF_CONDUCT.md).
15+
- [ ] Checked for [duplicate issues](https://github.com/iamturns/create-exposed-app/issues).
16+
17+
**Issue**
18+
Describe your issue here.

‎.github/ISSUE_TEMPLATE/BUG_REPORT.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
name: Bug report
3+
about: Something isn't working as expected?
4+
labels: bug-report
5+
assignees: @iamturns
6+
---
7+
8+
<!--
9+
Thanks for being willing to contribute!
10+
First step: provide a general summary of the bug in the Title above
11+
-->
12+
13+
**Checklist**
14+
15+
<!-- Put an x in the boxes that apply: [X]. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! -->
16+
17+
- [ ] Following [CODE_OF_CONDUCT.md](https://github.com/iamturns/create-exposed-app/blob/master/CODE_OF_CONDUCT.md).
18+
- [ ] Checked for [duplicate bug reports](https://github.com/iamturns/create-exposed-app/issues?q=label%3Abug-report).
19+
20+
**Bug report**
21+
Provide a more detailed introduction to the issue itself, and why you consider it to be a bug.
22+
23+
**Expected behavior**
24+
What should happen?
25+
26+
**Actual behaviour**
27+
What happens instead? Please include if possible and/or relevant: error messages, stack traces, logs, screenshots.
28+
29+
**Steps to reproduce**
30+
31+
1. ...
32+
2. ...
33+
3. ...
34+
35+
Please include if possible and/or relevant: code, config, links, repository that reproduces the bug.
36+
37+
**Environment**
38+
39+
- `create-exposed-app` version:
40+
- Operating System and version:
41+
- _Client-side bug?_
42+
- Device used: [e.g. iPhone 6, MacBook Pro]
43+
- Browser name and version: [e.g. Chrome XX | Safari XX | Android Browser XX ]
44+
- _Server-side bug?_
45+
- Node.js version:
46+
- npm version:
47+
48+
Run the following script to collect version information:
49+
50+
```bash
51+
node -e "\
52+
const os = require('os');\
53+
const cp = require('child_process');\
54+
console.log('Operating System and version:: ' + os.platform() + ' ' + os.release());\
55+
console.log('Node.js version: ' + process.version);\
56+
console.log('npm version: ' + cp.execSync('npm -v'));\
57+
"
58+
```
59+
60+
**Additional**
61+
E.g. suggested solution, theories, etc.

‎.github/ISSUE_TEMPLATE/CHANGE_REQUEST.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Change request
3+
about: Wish something was different?
4+
labels: change-request
5+
assignees: @iamturns
6+
---
7+
8+
<!--
9+
Thanks for being willing to contribute!
10+
First step: provide a general summary of the change request in the Title above
11+
-->
12+
13+
**Checklist**
14+
15+
<!-- Put an x in the boxes that apply: [X]. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! -->
16+
17+
- [ ] Following [CODE_OF_CONDUCT.md](https://github.com/iamturns/create-exposed-app/blob/master/CODE_OF_CONDUCT.md).
18+
- [ ] Checked for [duplicate change requests](https://github.com/iamturns/create-exposed-app/issues?q=label%3Achange-request).
19+
20+
**Change request**
21+
Describe your change request here.
22+
23+
Possible details to include:
24+
25+
- What would you like changed?
26+
- Why would you like this change?
27+
- How can it benefit others?
28+
- Possible implementation
29+
- Alternative changes or solutions considered

‎.github/ISSUE_TEMPLATE/QUESTION.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Question
3+
about: Need help? Curious? Ask away!
4+
labels: question
5+
assignees: @iamturns
6+
---
7+
8+
<!--
9+
Thanks for being willing to contribute!
10+
First step: provide a general summary of the question in the Title above
11+
-->
12+
13+
**Checklist**
14+
15+
<!-- Put an x in the boxes that apply: [X]. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! -->
16+
17+
- [ ] Following [CODE_OF_CONDUCT.md](https://github.com/iamturns/create-exposed-app/blob/master/CODE_OF_CONDUCT.md).
18+
- [ ] Checked for [duplicate questions](https://github.com/iamturns/create-exposed-app/issues?q=label%3Aquestion).
19+
20+
**Question**
21+
Ask your question here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!--
2+
Thanks for being willing to contribute!
3+
First step: provide a general summary of your changes in the Title above
4+
-->
5+
6+
**Checklist**
7+
8+
<!-- Put an x in the boxes that apply: [X]. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! -->
9+
10+
- [ ] Following [CODE_OF_CONDUCT.md](https://github.com/iamturns/create-exposed-app/blob/master/CODE_OF_CONDUCT.md).
11+
- [ ] Checked for [duplicate pull requests](https://github.com/iamturns/create-exposed-app/pulls)
12+
- [ ] Pulling from a branch (right side), not `master`.
13+
- [ ] Pulling into `master` branch (left side).
14+
- [ ] Fixing a bug? An open [bug report](https://github.com/iamturns/create-exposed-app/labels/bug-report) exists.
15+
- [ ] Breaking API changes? Migration notes attached.
16+
17+
**Info**
18+
19+
- Type: [bug fix | new feature]
20+
- Related issue(s): #123, #456
21+
22+
**Pull request**
23+
Describe your pull request here.
24+
25+
Possible details to include:
26+
27+
- Screenshots / gif demo
28+
- What has changed?
29+
- Why was it changed?
30+
- Reasons for choosing this solution, and alternative solutions considered

‎CODE_OF_CONDUCT.md‎

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

‎CONTRIBUTING.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
Thanks for being willing to contribute!
44

5-
## Submitting Bug Reports
5+
## Submitting a Bug Report, Change Request, Question, or General Issue
66

7-
Please use the [GitHub issue tracker](https://github.com/iamturns/create-exposed-app/issues). Before creating a new issue, do a quick search to see if the problem has been reported already.
7+
Please use the [GitHub issue tracker](https://github.com/iamturns/create-exposed-app/issues).
88

99
## Contributing Code
1010

1111
See [DEVELOPING.md](DEVELOPING.md).
1212

13-
First time contributing code to an open source project on GitHub? Learn how with this [free video tutorial](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
13+
First time contributing code to an open source project on GitHub? Learn how from this [free video tutorial](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).

‎LICENSE‎

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
11
The MIT License (MIT)
2+
Copyright (c) Matt Turnbull <[email protected]>
23

3-
Copyright © Matt Turnbull <[email protected]>
4+
Permission is hereby granted, free of charge, to any person obtaining a copy
5+
of this software and associated documentation files (the "Software"), to deal
6+
in the Software without restriction, including without limitation the rights
7+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8+
copies of the Software, and to permit persons to whom the Software is
9+
furnished to do so, subject to the following conditions:
410

5-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
11+
The above copyright notice and this permission notice shall be included in all
12+
copies or substantial portions of the Software.
613

7-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8-
9-
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18+
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
19+
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
20+
OR OTHER DEALINGS IN THE SOFTWARE.

‎MAINTAINING.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This guide is intended for maintainers (anybody with commit access).
44

5+
## Code of Conduct
6+
7+
Please make sure you're familiar with and follow the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
8+
59
## Approving Pull Requests
610

711
1. Use "Squash and Merge". This keeps a clean history in `master`, with a full history available in Pull Requests.

‎README.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ npm init exposed-app
1919
- Tools configured with sensible defaults
2020
- Powered by [TypeScript](https://www.typescriptlang.org/), [Babel](https://babeljs.io/), [Jest](https://jestjs.io/), [ESLint](https://eslint.org/), and more
2121
- Useful `npm run` scripts with `:watch` pairs, including `format`, `lint`, `typecheck`, `test`, `build`, `validate`
22-
- Powered by [nodemon](https://nodemon.io/), [npm-run-all](https://www.npmjs.com/package/npm-run-all), and more
22+
- Powered by [nodemon](https://nodemon.io/), [onchange](https://github.com/Qard/onchange), [npm-run-all](https://github.com/mysticatea/npm-run-all), and more
2323
- Format (beautify) files
2424
- Powered by [Prettier](https://prettier.io/), [import-sort](https://github.com/renke/import-sort), [prettier-package-json](https://github.com/cameronhunter/prettier-package-json)
2525
- CI/CD
@@ -29,13 +29,16 @@ npm init exposed-app
2929
- Automatically format, lint, and test changed files
3030
- Powered by [lint-staged](https://github.com/okonet/lint-staged), [husky](https://github.com/typicode/husky)
3131
- Documentation templates
32-
- [Architectural Decision Records](https://adr.github.io/), README.md, CHANGELOG.md, DEVELOPING.md, CONTRIBUTING.md, MAINTAINING.md, LICENSE
32+
- README.md, CHANGELOG.md, CODE_OF_CONDUCT.md, DEVELOPING.md, CONTRIBUTING.md, MAINTAINING.md, and LICENSE
33+
- [GitHub templates](https://help.github.com/articles/about-issue-and-pull-request-templates/) for pull requests, bug reports, change requests, questions, and general issues.
34+
- [Architectural Decision Records](https://adr.github.io/)
3335
- Automatic table of contents generation (powered by [doctoc](https://github.com/thlorenz/doctoc))
3436
- VS Code launch scripts and settings
3537

3638
## Additional Documentation
3739

3840
- [CHANGELOG.md](CHANGELOG.md)
41+
- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
3942
- [DEVELOPING.md](DEVELOPING.md)
4043
- [CONTRIBUTING.md](CONTRIBUTING.md)
4144
- [MAINTAINING.md](MAINTAINING.md)

0 commit comments

Comments
 (0)