Skip to content
This repository was archived by the owner on Aug 28, 2024. It is now read-only.

Commit fed8a51

Browse files
committed
chore: add contributors
1 parent 07de47f commit fed8a51

File tree

3 files changed

+71
-0
lines changed

3 files changed

+71
-0
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Update Contributors in README
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
update-readme:
10+
name: Update the README
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Update the list of contributors
15+
uses: akhilmhdh/contributors-readme-action@v2.3.6
16+
with:
17+
use_username: true
18+
env:
19+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CONTRIBUTING

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing
2+
3+
Contributions are welcome. We’re using [pnpm](https://pnpm.io/).
4+
5+
Install all dependencies:
6+
`$ pnpm install`
7+
8+
Run the tests:
9+
`$ pnpm turbo watch`
10+
11+
Build all packages:
12+
`$ pnpm turbo build`
13+
14+
We require a semantic PR title, e. g.:
15+
16+
```
17+
docs: Add information about semantic commits
18+
^ ^
19+
| |__ Subject
20+
|________ Prefix
21+
```
22+
23+
Here are all the prefixes you need to know:
24+
25+
| Prefix | Description |
26+
| -------- | ----------------------------------------------------------------------------------------------------------- |
27+
| feat | A new feature |
28+
| fix | A bug fix |
29+
| docs | Documentation only changes |
30+
| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
31+
| refactor | A code change that neither fixes a bug nor adds a feature |
32+
| perf | A code change that improves performance |
33+
| test | Adding missing tests or correcting existing tests |
34+
| build | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
35+
| ci | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
36+
| chore | Other changes that don't modify src or test files |
37+
| revert | Reverts a previous commit |

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,18 @@ console.log(format({
7272
tree:
7373
}))
7474
```
75+
76+
## Community
77+
78+
We are API nerds. You too? Let’s chat on Discord: <https://discord.gg/8HeZcRGPFS>
79+
80+
## Contributors
81+
82+
<!-- readme: collaborators,contributors -start -->
83+
<!-- readme: collaborators,contributors -end -->
84+
85+
Contributions are welcome! Read [`CONTRIBUTING`](https://github.com/scalar/snippetz/blob/main/CONTRIBUTING).
86+
87+
## License
88+
89+
The source code in this repository is licensed under [MIT](https://github.com/scalar/snippetz/blob/main/LICENSE).

0 commit comments

Comments
 (0)