Skip to content

Commit 5526b33

Browse files
ahammondahammond
committed
first commit
0 parents  commit 5526b33

File tree

15 files changed

+2031
-0
lines changed

15 files changed

+2031
-0
lines changed

‎.DS_Store‎

6 KB
Binary file not shown.

‎.github/ISSUE_TEMPLATE/01_bug.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: "🐛 Bug Report"
3+
about: "If something isn't working as expected 🤔"
4+
labels: bug
5+
---
6+
7+
<!-- Please replace all placeholders such as this below -->
8+
9+
**What happened?**
10+
11+
<!-- Describe the problem and how to reproduce it. Add screenshots or a link to your repository if possible and helpful -->
12+
13+
**What did you expect to happen?**
14+
15+
<!-- Describe what you expected to happen instead -->
16+
17+
**What the problem might be**
18+
19+
<!-- If you have an idea where the bug might lie, please share here. Otherwise remove the whole section -->

‎.github/ISSUE_TEMPLATE/02_feature_request.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: "🧚‍♂️ Feature Request"
3+
about: "Wouldn’t it be nice if 💭"
4+
labels: feature
5+
---
6+
7+
<!-- Please replace all placeholders such as this below -->
8+
9+
**What’s missing?**
10+
11+
<!-- Describe your feature idea -->
12+
13+
**Why?**
14+
15+
<!-- Describe the problem you are facing -->
16+
17+
**Alternatives you tried**
18+
19+
<!-- Describe the workarounds you tried so far and how they worked for you -->

‎.github/renovate.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"extends": [
3+
"github>octoherd/.github"
4+
]
5+
}

‎.github/workflows/release.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Release
2+
"on":
3+
push:
4+
branches:
5+
- main
6+
jobs:
7+
release:
8+
name: release
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v3
12+
- uses: actions/setup-node@v3
13+
with:
14+
node-version: lts/*
15+
cache: npm
16+
- run: npm ci
17+
- run: npx semantic-release
18+
env:
19+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
20+
NPM_TOKEN: ${{ secrets.NPM_AUTOMATION_TOKEN }}

‎.github/workflows/test.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Test
2+
"on":
3+
push:
4+
branches:
5+
- main
6+
pull_request:
7+
types:
8+
- opened
9+
- synchronize
10+
jobs:
11+
test_matrix:
12+
runs-on: ubuntu-latest
13+
strategy:
14+
matrix:
15+
node_version:
16+
- "18"
17+
steps:
18+
- uses: actions/checkout@v3
19+
- name: Use Node.js ${{ matrix.node_version }}
20+
uses: actions/setup-node@v3
21+
with:
22+
node-version: ${{ matrix.node_version }}
23+
cache: npm
24+
- run: npm ci
25+
- run: npm test
26+
test:
27+
runs-on: ubuntu-latest
28+
needs: test_matrix
29+
steps:
30+
- run: echo ok

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
node_modules

‎CODE_OF_CONDUCT.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
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, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
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 octoherd+coc@martynus.net. 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://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: https://contributor-covenant.org
74+
[version]: https://contributor-covenant.org/version/1/4/

‎CONTRIBUTING.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# How to contribute
2+
3+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
4+
By participating in this project you agree to abide by its terms.
5+
6+
We appreciate you taking the time to contribute to `@octoherd/script-hello-world`. Especially as a new contributor, you have a valuable perspective that we lost a long time ago: you will find things confusing and run into problems that no longer occur to us. Please share them with us, so we can make the experience for future contributors the best it could be.
7+
8+
Thank you 💖
9+
10+
## Creating an Issue
11+
12+
Before you create a new Issue:
13+
14+
1. Please make sure there is no [open issue](https://github.com/octoherd/script-hello-world/issues?utf8=%E2%9C%93&q=is%3Aissue) yet.
15+
2. If it is a bug report, include the steps to reproduce the issue
16+
3. If it is a feature request, please share the motivation for the new feature, what alternatives you tried, and how you would implement it.
17+
18+
## Setup the repository locally
19+
20+
First, fork the repository.
21+
22+
Setup the repository locally. Replace `<your account name>` with the name of the account you forked to.
23+
24+
```shell
25+
git clone https://github.com/<your account name>/script-hello-world.git
26+
cd script-hello-world
27+
npm install
28+
```
29+
30+
Run the tests before making changes to make sure the local setup is working as expected
31+
32+
```shell
33+
npm test
34+
```
35+
36+
## Submitting the Pull Request
37+
38+
- Create a new branch locally.
39+
- Make your changes in that branch and push them to your fork
40+
- Submit a pull request from your topic branch to the main branch on the `octoherd/script-hello-world` repository.
41+
- Be sure to tag any issues your pull request is taking care of / contributing to. Adding "Closes #123" to a pull request description will automatically close the issue once the pull request is merged in.
42+
43+
## Maintainers only
44+
45+
### Merging the Pull Request & releasing a new version
46+
47+
Releases are automated using [semantic-release](https://github.com/semantic-release/semantic-release).
48+
The following commit message conventions determine which version is released:
49+
50+
1. `fix: ...` or `fix(scope name): ...` prefix in subject: bumps fix version, e.g. `1.2.3` → `1.2.4`
51+
2. `feat: ...` or `feat(scope name): ...` prefix in subject: bumps feature version, e.g. `1.2.3` → `1.3.0`
52+
3. `BREAKING CHANGE:` in body (**Important**: commit body, not subject!): bumps breaking version, e.g. `1.2.3` → `2.0.0`
53+
54+
Only one version number is bumped at a time, the highest version change trumps the others.
55+
Besides publishing a new version to npm, semantic-release also creates a git tag and release
56+
on GitHub, generates changelogs from the commit messages and puts them into the release notes.
57+
58+
If the pull request looks good but does not follow the commit conventions, use the <kbd>Squash & merge</kbd> button.

‎LICENSE.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Copyright 2021 Octoherd contributors
2+
3+
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
4+
5+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
6+

0 commit comments

Comments
 (0)