Skip to content

Commit b28380a

Browse files
Add contributors workflow and contribution guidelines (#107)
* Adds a workflow to greet first time contributors * Update contribution guidelines
1 parent ee4b730 commit b28380a

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

.github/workflows/welcome.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Welcome New Contributors
2+
3+
on:
4+
issues:
5+
types: [opened]
6+
pull_request_target:
7+
branches: [main]
8+
types: [opened]
9+
10+
jobs:
11+
greet:
12+
name: Greet New Contributors
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/first-interaction@v1
16+
with:
17+
repo-token: ${{ secrets.GITHUB_TOKEN }}
18+
pr-message: |
19+
Thank you for your first ever contribution to System Design 101! 🎉
20+
21+
Please make sure to follow the [contribution guidelines](https://github.com/ByteByteGoHq/system-design-101/blob/main/CONTRIBUTING.md) when contributing to this project. Any PRs that don't follow the guidelines will be closed.
22+
23+
Thanks for choosing to contribute, and for helping make this project better! 🌟

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,12 @@ Thank you for your interest in contributing! Here are some guidelines to follow
99
* Avoid making changes across multiple topics in the same PR.
1010
* Give your PR a clear title summarizing the topic you are addressing.
1111
* If you notice typos or issues in diagrams, please open a separate issue instead of fixing the images directly. We will update the source images and republish fixes.
12+
* Please do not use AI tools to generate the content.
1213

1314
### GitHub Pull Requests Docs
1415

1516
If you are not familiar with pull requests, review the [pull request docs](https://help.github.com/articles/using-pull-requests/).
17+
18+
## Translations
19+
20+
We are not planning to translate the guides into other languages at this time. Feel free to star/watch the repo if you want to get notified for when we do.

0 commit comments

Comments
 (0)