From 33c96f8dbecf57dc135b3d5fd3c58eecc9ea68a9 Mon Sep 17 00:00:00 2001 From: Diogo Ribeiro Date: Thu, 19 Jun 2025 20:19:14 +0100 Subject: [PATCH 1/5] Refine author section and extend roadmap --- README.md | 9 +++++++++ ROADMAP.md | 13 ++++++++++++- 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6067243..b14064e 100644 --- a/README.md +++ b/README.md @@ -181,3 +181,12 @@ yarn check-version If you use **smart-todo-action**, please cite it using the metadata in [CITATION.cff](CITATION.cff). This file contains the DOI and author information for reference managers. +## 👤 Author + +This project is maintained by [Diogo Ribeiro](https://github.com/DiogoRibeiro7). + +- **ORCID:** [0009-0001-2022-7072](https://orcid.org/0009-0001-2022-7072) +- **Affiliation:** ESMAD - Instituto Politécnico do Porto +- **Personal email:** +- **Professional email:** + diff --git a/ROADMAP.md b/ROADMAP.md index ab9c624..85823a2 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -57,13 +57,24 @@ A smart GitHub Action that detects, classifies, and transforms inline TODOs into > Make it fast, reliable, and easy to adopt across the community. - [ ] Plugin-based architecture (LLM integration, reporters, etc.) -- [ ] CLI mode (run locally or in CI/CD) +- [x] CLI mode (run locally or in CI/CD) - [ ] >90% test coverage - [ ] Full documentation & usage guides - [ ] Publish to GitHub Marketplace --- +## 🫂 Phase 6: Community Engagement + +> Foster an active ecosystem and support network. + +- [ ] Contributor guidelines and code of conduct +- [ ] Example workflows and tutorials +- [ ] Discussion board or Discord for support +- [ ] Regular release announcements + +--- + ## 📌 Notes - Built with extensibility and automation in mind. From b693abd418da6688daa9dd005222ff99bcfc3409 Mon Sep 17 00:00:00 2001 From: Diogo Ribeiro Date: Thu, 19 Jun 2025 20:51:35 +0100 Subject: [PATCH 2/5] fix(ci): correct indentation --- .github/workflows/bump_version.yml | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/.github/workflows/bump_version.yml b/.github/workflows/bump_version.yml index d385323..b295a58 100644 --- a/.github/workflows/bump_version.yml +++ b/.github/workflows/bump_version.yml @@ -31,8 +31,15 @@ jobs: - name: Commit and push changes run: | - git config --global user.name "github-actions[bot]" - git config --global user.email "github-actions[bot]@users.noreply.github.com" - git add package.json - git diff --cached --quiet && echo "No version change." || git commit -m "chore(release): bump version [skip ci]" - git push + git config --global user.name "github-actions[bot]" + git config --global user.email "github-actions[bot]@users.noreply.github.com" + git add package.json + if git diff --cached --quiet; then + echo "No version change." + else + git commit -m "chore(release): bump version [skip ci]" + git push + VERSION=$(node -p "require('./package.json').version") + git tag "v${VERSION}" + git push origin "v${VERSION}" + fi From 3c9e930cc2b0f9d09ec0d0f7eed9bfcca41bb10b Mon Sep 17 00:00:00 2001 From: Diogo Ribeiro Date: Thu, 19 Jun 2025 20:51:41 +0100 Subject: [PATCH 3/5] docs: add contributing guidelines --- CODE_OF_CONDUCT.md | 39 +++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++++++ README.md | 5 +++++ ROADMAP.md | 2 +- 4 files changed, 85 insertions(+), 1 deletion(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..d714e8a --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,39 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our community include: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience +- Focusing on what is best not just for us as individuals, but for the overall community + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery, and sexual attention or advances of any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all community spaces and also applies when an individual is officially representing the community in public spaces. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at . All complaints will be reviewed and investigated promptly and fairly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ff65ac1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Contributing to smart-todo-action + +Thank you for considering contributing to **smart-todo-action**! We welcome pull requests and issues. + +## Development Setup + +1. **Install dependencies** + ```bash + yarn install + ``` +2. **Run tests** + ```bash + yarn test + ``` +3. **Run the linter** + ```bash + yarn lint + ``` + +## Pull Requests + +- Fork the repository and create a new branch for your change. +- Write tests for new functionality whenever possible. +- Ensure `yarn test` passes before submitting. +- Provide a clear description of your change in the PR body. + +## Code Style + +All functions should include docstrings in the [Google format](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings). Use inline comments to explain non-obvious logic. + +## Reporting Issues + +If you encounter a bug or have a feature request, please open an issue. Feel free to reach out via email if you need further assistance: + +- Personal: +- Professional: + +## Code of Conduct + +Please note that this project is released with a [Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. diff --git a/README.md b/README.md index b14064e..e9c0fa6 100644 --- a/README.md +++ b/README.md @@ -190,3 +190,8 @@ This project is maintained by [Diogo Ribeiro](https://github.com/DiogoRibeiro7). - **Personal email:** - **Professional email:** + +## 🤝 Contributing + +We welcome contributions! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines and make sure to follow our [Code of Conduct](CODE_OF_CONDUCT.md). + diff --git a/ROADMAP.md b/ROADMAP.md index 85823a2..58ffdc6 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -68,7 +68,7 @@ A smart GitHub Action that detects, classifies, and transforms inline TODOs into > Foster an active ecosystem and support network. -- [ ] Contributor guidelines and code of conduct +- [x] Contributor guidelines and code of conduct - [ ] Example workflows and tutorials - [ ] Discussion board or Discord for support - [ ] Regular release announcements From 49d45441865dea053f408ac0c81862513c4b02c1 Mon Sep 17 00:00:00 2001 From: Diogo Ribeiro Date: Thu, 19 Jun 2025 21:05:23 +0100 Subject: [PATCH 4/5] docs: update roadmap --- README.md | 2 ++ ROADMAP.md | 2 +- examples/README.md | 7 +++++++ examples/todo.yml | 23 +++++++++++++++++++++++ 4 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 examples/README.md create mode 100644 examples/todo.yml diff --git a/README.md b/README.md index e9c0fa6..f4d34de 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,8 @@ jobs: llm-provider: openai # or 'gemini' ``` +See the [examples](examples/) directory for a complete workflow configuration. + Set `OPENAI_API_KEY` or `GEMINI_API_KEY` secrets based on your chosen provider. ### 2. Run the CLI locally diff --git a/ROADMAP.md b/ROADMAP.md index 58ffdc6..bc3db3a 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -69,7 +69,7 @@ A smart GitHub Action that detects, classifies, and transforms inline TODOs into > Foster an active ecosystem and support network. - [x] Contributor guidelines and code of conduct -- [ ] Example workflows and tutorials +- [x] Example workflows and tutorials - [ ] Discussion board or Discord for support - [ ] Regular release announcements diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..dca59b7 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,7 @@ +# Example Workflows + +This directory contains sample configurations demonstrating how to use **smart-todo-action** in your own projects. + +- [`todo.yml`](todo.yml) – Minimal workflow that installs dependencies and runs the action on each push to `main`. + +Feel free to copy and adapt these files to suit your needs. diff --git a/examples/todo.yml b/examples/todo.yml new file mode 100644 index 0000000..2726b83 --- /dev/null +++ b/examples/todo.yml @@ -0,0 +1,23 @@ +name: Smart TODO Action Example + +on: + push: + branches: [main] + +jobs: + smart-todo: + runs-on: ubuntu-latest + permissions: + issues: write + steps: + - uses: actions/checkout@v4 + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: 20 + - run: yarn install + - run: yarn prepare + - name: Run Smart TODO Action + uses: DiogoRibeiro7/smart-todo-action@v1 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} From c379efa7fab816f6a9c5ee00bd1fef271db97f23 Mon Sep 17 00:00:00 2001 From: Diogo Ribeiro Date: Thu, 19 Jun 2025 21:33:31 +0100 Subject: [PATCH 5/5] docs: add community support section --- README.md | 8 ++++++++ ROADMAP.md | 2 +- SUPPORT.md | 8 ++++++++ 3 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 SUPPORT.md diff --git a/README.md b/README.md index f4d34de..9363dd4 100644 --- a/README.md +++ b/README.md @@ -197,3 +197,11 @@ This project is maintained by [Diogo Ribeiro](https://github.com/DiogoRibeiro7). We welcome contributions! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines and make sure to follow our [Code of Conduct](CODE_OF_CONDUCT.md). +## 💬 Community Support + +If you need help or want to discuss ideas, join our community spaces +([details](SUPPORT.md)): + +- [GitHub Discussions](https://github.com/DiogoRibeiro7/smart-todo-action/discussions) +- [Discord](https://discord.gg/smart-todo-action) + diff --git a/ROADMAP.md b/ROADMAP.md index bc3db3a..7df25f5 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -70,7 +70,7 @@ A smart GitHub Action that detects, classifies, and transforms inline TODOs into - [x] Contributor guidelines and code of conduct - [x] Example workflows and tutorials -- [ ] Discussion board or Discord for support +- [x] Discussion board or Discord for support - [ ] Regular release announcements --- diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 0000000..e03e641 --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,8 @@ +# 💬 Community Support + +Join the discussion board to get help, share ideas, and connect with other users. + +- **GitHub Discussions:** [DiogoRibeiro7/smart-todo-action Discussions](https://github.com/DiogoRibeiro7/smart-todo-action/discussions) +- **Discord:** [https://discord.gg/smart-todo-action](https://discord.gg/smart-todo-action) + +Feel free to open a topic if you have questions or need assistance.