diff --git a/.github/workflows/todo-issues.yml b/.github/workflows/todo-issues.yml new file mode 100644 index 000000000..f3096cac1 --- /dev/null +++ b/.github/workflows/todo-issues.yml @@ -0,0 +1,18 @@ +name: Create TODO Issues + +on: + push: + branches: + - dev + - main + workflow_dispatch: + +jobs: + todo-issues: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: alstr/todo-to-issue-action@v4 + with: + TOKEN: ${{ secrets.GITHUB_TOKEN }} + diff --git a/README.md b/README.md index 2bc6bdadc..b161b5172 100644 --- a/README.md +++ b/README.md @@ -67,3 +67,21 @@ This command will guide you through the steps necessary to release the package. ## Contributing Contributions are very welcome! Everyone interacting in our codebases, issue trackers, and any other form of communication, including chat rooms and mailing lists, is expected to follow our [code of conduct](./CODE_OF_CONDUCT.md) so we can all enjoy the effort we put into this project. + +## TODO tracking + +This project uses an automated workflow to convert `TODO` comments into GitHub issues. +Whenever you push changes to the `dev` or `main` branches, the **Create TODO Issues** +GitHub Action scans the repository for `TODO:` markers and opens issues for any +new entries. + +If you already have an issue that relates to a TODO, reference the issue number +directly in the comment so it links back to the code location: + +```ts +// TODO(#123): handle reconnect logic +``` + +Linking code and issues in this way keeps outstanding work visible and easy to +track. +