Skip to content

Commit aa7f434

Browse files
SocketSomeoneSocketSomeone
committed
chore: update .github files
1 parent 797460a commit aa7f434

File tree

11 files changed

+187
-0
lines changed

11 files changed

+187
-0
lines changed

‎.github/COMMIT_CONVENTION.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
## Git Commit Message Convention
2+
3+
> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
4+
5+
#### TL;DR:
6+
7+
Messages must be matched by the following regex:
8+
9+
```js
10+
/^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\(.+\))?: .{1,72}/;
11+
```
12+
13+
### Full Message Format
14+
15+
A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
16+
17+
```
18+
<type>(<scope>): <subject>
19+
<BLANK LINE>
20+
<body>
21+
<BLANK LINE>
22+
<footer>
23+
```
24+
25+
The **header** is mandatory and the **scope** of the header is optional.
26+
27+
### Revert
28+
29+
If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body, it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
30+
31+
### Type
32+
33+
If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. However, if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
34+
35+
Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks.
36+
37+
### Scope
38+
39+
The scope could be anything specifying the place of the commit change. For example `SlashCommand`, `ContextMenu`, `MessageComponents` etc...
40+
41+
### Subject
42+
43+
The subject contains a succinct description of the change:
44+
45+
- use the imperative, present tense: "change" not "changed" nor "changes"
46+
- don't capitalize the first letter
47+
- no dot (.) at the end
48+
49+
### Body
50+
51+
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
52+
The body should include the motivation for the change and contrast this with previous behavior.
53+
54+
### Footer
55+
56+
The footer should contain any information about **Breaking Changes** and is also the place to
57+
reference GitHub issues that this commit **Closes**.
58+
59+
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.

‎.github/CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing
2+
3+
If you wish to contribute to the nestjs-hot-shots codebase or documentation, feel free to fork the repository and submit a
4+
pull request. We use ESLint to enforce a consistent coding style, so having that set up in your editor of choice
5+
is a great boon to your development process.
6+
7+
## Setup
8+
9+
You will need [Node.js](http://nodejs.org) **version 12+**, and [npm](https://www.npmjs.com/).
10+
11+
To get ready to work on the codebase, please do the following:
12+
13+
1. Fork & clone the repository, and make sure you're on the **master** branch
14+
2. Run `npm ci`
15+
3. Code your heart out!
16+
4. Run `npm lint` to run ESLint ensures changes are valid
17+
5. [Submit a pull request](https://github.com/SocketSomeone/nestjs-hot-shots/compare) (Make sure you follow the [conventional commit format](https://github.com/SocketSomeone/nestjs-hot-shots/blob/main/.github/COMMIT_CONVENTION.md))
18+
19+
A high level overview of tools used:
20+
21+
- [TypeScript](https://www.typescriptlang.org/) as the development language
22+
- [Eslint](https://eslint.org/) for code-style
23+
- [Prettier](https://prettier.io/) for code formatting

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: 🐛 Bug report
2+
description: Report incorrect or unexpected behavior of nestjs-hot-shots
3+
labels: [bug, need repro]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Issue description
9+
description: |
10+
Describe the issue in as much detail as possible.
11+
12+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files into it.
13+
placeholder: |
14+
Steps to reproduce with below code sample:
15+
1. do thing
16+
2. observe behavior
17+
3. see error logs below
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: codesample
22+
attributes:
23+
label: Code sample
24+
description: Include a reproducible, minimal code sample. This will be automatically formatted into code, so no need for backticks.
25+
render: typescript
26+
- type: input
27+
id: node-version
28+
attributes:
29+
label: Node.js version
30+
description: |
31+
Which version of Node.js are you using? Run `node --version` in your project directory and paste the output.
32+
If you are using TypeScript, please include its version (`npm list typescript`) as well.
33+
validations:
34+
required: true
35+
- type: input
36+
id: os
37+
attributes:
38+
label: Operating system
39+
description: Which OS does your application run on?
40+
- type: dropdown
41+
id: priority
42+
attributes:
43+
label: Priority this issue should have
44+
description: Please be realistic. If you need to elaborate on your reasoning, please use the Issue description field above.
45+
options:
46+
- Low (slightly annoying)
47+
- Medium (should be fixed soon)
48+
- High (immediate attention needed)
49+
validations:
50+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

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

‎.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: 🚀 Feature request
2+
description: Request a new feature
3+
labels: [feature request]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Feature
9+
description: A clear and concise description of what the problem is, or what feature you want to be implemented.
10+
placeholder: I'm always frustrated when..., Hot-shots has recently released..., A good addition would be...
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: solution
15+
attributes:
16+
label: Ideal solution or implementation
17+
description: A clear and concise description of what you want to happen.
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: alternatives
22+
attributes:
23+
label: Alternative solutions or implementations
24+
description: A clear and concise description of any alternative solutions or features you have considered.
25+
- type: textarea
26+
id: additional-context
27+
attributes:
28+
label: Other context
29+
description: Any other context, screenshots, or file uploads that help us understand your feature request.

‎.github/ISSUE_TEMPLATE/question.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: ❓ Questions and Support Request
2+
description: Ask the developer about the library
3+
labels: [question]
4+
body:
5+
- type: textarea
6+
id: issue-description
7+
attributes:
8+
label: What is your question?
9+
description: Please try to be as clear and concise as possible.
10+
validations:
11+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
**Please describe the changes this PR makes and why it should be merged:**
2+
3+
**Status and versioning classification:**
4+
5+
<!--
6+
Please move lines that apply to you out of the comment:
7+
- Code changes have been tested against the Datadog or Telegraf, or there are no code changes
8+
- I know how to update typings and have done so, or typings don't need updating
9+
- This PR changes the library's interface (methods or parameters added)
10+
- This PR includes breaking changes (methods removed or renamed, parameters moved or removed)
11+
- This PR **only** includes non-code changes, like changes to documentation, README, etc.
12+
-->

‎.github/dependabot.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
version: 2
22
updates:
33
- package-ecosystem: github-actions
4+
rebase-strategy: "auto"
45
directory: "/"
56
schedule:
67
interval: daily
78
- package-ecosystem: npm
9+
rebase-strategy: "auto"
810
directory: "/"
911
schedule:
1012
interval: daily

‎husky/.gitignore renamed to ‎.husky/.gitignore

File renamed without changes.

‎husky/commit-msg renamed to ‎.husky/commit-msg

File renamed without changes.

‎husky/pre-commit renamed to ‎.husky/pre-commit

File renamed without changes.

0 commit comments

Comments
 (0)