Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions .github/workflows/bump_version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
39 changes: 39 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>. 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.
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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: <[email protected]>
- Professional: <[email protected]>

## 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.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -181,3 +183,25 @@ 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:** <[email protected]>
- **Professional email:** <[email protected]>


## 🤝 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).

## 💬 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)

13 changes: 12 additions & 1 deletion ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
- [x] Contributor guidelines and code of conduct
- [x] Example workflows and tutorials
- [x] Discussion board or Discord for support
- [ ] Regular release announcements

---

## 📌 Notes

- Built with extensibility and automation in mind.
Expand Down
8 changes: 8 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 7 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -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.
23 changes: 23 additions & 0 deletions examples/todo.yml
Original file line number Diff line number Diff line change
@@ -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 }}
Loading