Skip to content

Commit 230ab68

Browse files
1aron1aron
committed
Init
0 parents  commit 230ab68

33 files changed

+24431
-0
lines changed

‎.commitlintrc.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
extends: aron

‎.editorconfig

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 4
6+
end_of_line = lf
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = false

‎.eslintrc.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
extends: aron

‎.github/CODE_OF_CONDUCT.md

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
i@aron.tw.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎.github/CONTRIBUTING.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contributing to Techor
2+
3+
## Developing
4+
Split a new terminal and run `npm run dev` in the project root to watch all packages change and build:
5+
```bash
6+
npm run dev
7+
```
8+
Split a new terminal and switch to the target directory for testing to avoid running tests from other packages:
9+
```bash
10+
cd packages/target
11+
```
12+
```bash
13+
npm run test -- --watch
14+
```
15+
16+
## Testing
17+
```bash
18+
npm run test
19+
```
20+
21+
Commit your tests ( and create a Pull Request ):
22+
```bash
23+
Add @1aron tests
24+
```
25+
26+
## Linting
27+
Follow the [Aron's ESLint Preset](https://github.com/1aron/aronrepo/tree/beta/packages/eslint-config)
28+
```bash
29+
npm run lint
30+
```
31+
32+
To automatically fix any violations in your code:
33+
```
34+
npm run lint -- --fix
35+
```
36+
37+
## Type Checking
38+
```bash
39+
npm run type-check
40+
```
41+
42+
## Commit Checking
43+
Follow the [Aron's Conventional Commits](https://github.com/1aron/aronrepo/tree/beta/packages/conventional-commits)
44+
```bash
45+
npm run commit-check
46+
```
47+
48+
## Checking
49+
You have to pass `npm run check` before submitting a pull request.
50+
```bash
51+
npm run check
52+
```
53+
The command includes all of the following checks:
54+
55+
## Building
56+
```
57+
npm run build
58+
```

‎.github/ISSUE_TEMPLATE/bug_report.yml

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: "🐞 Bug"
2+
description: Report a bug
3+
title: '🐞 '
4+
labels: [bug]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: Thanks for taking the time to make a bug report!
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: Please provide a detailed description to tell us what the bug is. Also tell us what is the expected behavior you think.
16+
placeholder: When I am going to ... by using ..., the "..." error happens. ...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduction
22+
attributes:
23+
label: Reproduction
24+
description: Please provide a step-by-step [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) of the bug. It helps us to efficiently track down the bug.
25+
placeholder: |
26+
1. ...
27+
2. ...
28+
3. ...
29+
validations:
30+
required: false
31+
32+
- type: textarea
33+
id: system
34+
attributes:
35+
label: System Informations
36+
description: Please provide the system informations related to the bug. Browser, OS, Node.js, Package Manager ...
37+
placeholder: |
38+
Browser: Chrome 99.0.1234.56
39+
OS: macOS 12.0.1 (amd64)
40+
Node.js: 16.31.1
41+
Package Manager: pnpm 6.32.3
42+
validations:
43+
required: true
44+
45+
- type: markdown
46+
attributes:
47+
value: Thank you for the bug report! We will try to investigate the bug as soon as possible.

‎.github/ISSUE_TEMPLATE/config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 🤔 Questions & Discussions
4+
url: https://github.com/1aron/techor/discussions
5+
about: Use GitHub discussions for forum-like discussions and questions.

‎.github/ISSUE_TEMPLATE/docs_request.yml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: '📄 Documentation'
2+
description: A request to update or improve documentation
3+
title: '📄 '
4+
labels: [documentation]
5+
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: What is the improvement or update you wish to see?
10+
description: 'Example: I would like to see more examples of how to use the xxx. Or, the xxx docs are missing information.'
11+
validations:
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Is there any context that might help us understand?
16+
description: A clear description of any added context that might help us understand.
17+
validations:
18+
required: true
19+
- type: input
20+
attributes:
21+
label: Does the docs page already exist? Please link to it.
22+
placeholder: https://
23+
validations:
24+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: "✨ Feature"
2+
description: Propose a new feature
3+
title: '✨ '
4+
labels: [enhancement]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: Have a great idea for a new feature? Let us know!
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: |
16+
Please tell us what you want to see in the next release and why you want to see it.
17+
If you are going to make a pull request, please let us know your scheduling.
18+
validations:
19+
required: true

‎.github/workflows/commit-check.yml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Commit Check
2+
on:
3+
push:
4+
branches:
5+
- '**'
6+
pull_request_target:
7+
types:
8+
- opened
9+
- reopened
10+
- edited
11+
- synchronize
12+
13+
jobs:
14+
check:
15+
name: 'commit-check'
16+
timeout-minutes: 15
17+
runs-on: ubuntu-20.04
18+
strategy:
19+
matrix:
20+
node-version: [18.12.1]
21+
steps:
22+
- uses: actions/checkout@v3
23+
with:
24+
fetch-depth: 0
25+
- uses: actions/setup-node@v3
26+
with:
27+
node-version: ${{ matrix.node-version }}
28+
cache: 'npm'
29+
- run: npm ci
30+
- run: npm run commit-check

‎.github/workflows/lint.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Lint
2+
on:
3+
push:
4+
branches:
5+
- '**'
6+
pull_request_target:
7+
types:
8+
- opened
9+
- reopened
10+
- edited
11+
- synchronize
12+
13+
jobs:
14+
lint:
15+
timeout-minutes: 15
16+
runs-on: ubuntu-20.04
17+
strategy:
18+
matrix:
19+
node-version: [18.12.1]
20+
steps:
21+
- uses: actions/checkout@v3
22+
- uses: actions/setup-node@v3
23+
with:
24+
node-version: ${{ matrix.node-version }}
25+
cache: 'npm'
26+
- run: npm ci
27+
- run: npm run lint

‎.github/workflows/pull-request-title-check.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Check title of pull request
2+
on:
3+
pull_request_target:
4+
types:
5+
- opened
6+
- reopened
7+
- edited
8+
- synchronize
9+
10+
jobs:
11+
check:
12+
timeout-minutes: 15
13+
runs-on: ubuntu-20.04
14+
strategy:
15+
matrix:
16+
node-version: [18.12.1]
17+
steps:
18+
- name: Aron Actions
19+
uses: 1aron/aronrepo@latest
20+
with:
21+
action: 'check-pull-request-title'
22+
env:
23+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)