diff --git a/.github/workflows/welcome.yml b/.github/workflows/welcome.yml new file mode 100644 index 0000000..efccc0f --- /dev/null +++ b/.github/workflows/welcome.yml @@ -0,0 +1,23 @@ +name: Welcome New Contributors + +on: + issues: + types: [opened] + pull_request_target: + branches: [main] + types: [opened] + +jobs: + greet: + name: Greet New Contributors + runs-on: ubuntu-latest + steps: + - uses: actions/first-interaction@v1 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + pr-message: | + Thank you for your first ever contribution to System Design 101! 🎉 + + 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. + + Thanks for choosing to contribute, and for helping make this project better! 🌟 \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index da16ad6..17fceb9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,12 @@ Thank you for your interest in contributing! Here are some guidelines to follow * Avoid making changes across multiple topics in the same PR. * Give your PR a clear title summarizing the topic you are addressing. * 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. +* Please do not use AI tools to generate the content. ### GitHub Pull Requests Docs If you are not familiar with pull requests, review the [pull request docs](https://help.github.com/articles/using-pull-requests/). + +## Translations + +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. \ No newline at end of file