diff --git a/.github/workflows/update-contributors.yaml b/.github/workflows/update-contributors.yaml new file mode 100644 index 0000000..784e670 --- /dev/null +++ b/.github/workflows/update-contributors.yaml @@ -0,0 +1,28 @@ +name: Update Contributors +on: + workflow_dispatch: + push: + branches: + - 'main' + +env: + UPDATE_CONTRIBUTORS_BRANCH: update-contributors + +jobs: + add-contributors: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Delete old branch (If it exists) + run: git push origin --delete ${{ env.UPDATE_CONTRIBUTORS_BRANCH }} + continue-on-error: true + - name: Create and push new branch + run: | + git branch ${{ env.UPDATE_CONTRIBUTORS_BRANCH }} + git push origin ${{ env.UPDATE_CONTRIBUTORS_BRANCH }} + # https://github.com/BobAnkh/add-contributors + - uses: BobAnkh/add-contributors@v0.2.2 + with: + ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BRANCH: ${{ env.UPDATE_CONTRIBUTORS_BRANCH }} + PULL_REQUEST: 'main' diff --git a/README.md b/README.md index 5d7ee39..7499a7c 100644 --- a/README.md +++ b/README.md @@ -59,3 +59,13 @@ linter: ``` In the above example, we have customized various lint rules by adjusting their settings in the `analysis_options.yaml` file. You can modify these settings according to your project's specific needs and coding style preferences. + +## How to contribute + +See [Contributor Guide] for contributing conventions. + +### Contributors + + + +[Contributor Guide]: docs/contributing/CONTRIBUTING.md