Skip to content

Commit 2f1afd4

Browse files
DiogoRibeiro7DiogoRibeiro7
authored
Feat/update readme (#205)
* Refine author section and extend roadmap * fix(ci): correct indentation * docs: add contributing guidelines * docs: update roadmap * docs: add community support section
1 parent fb2e3fd commit 2f1afd4

File tree

8 files changed

+165
-6
lines changed

8 files changed

+165
-6
lines changed

‎.github/workflows/bump_version.yml‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,15 @@ jobs:
3131

3232
- name: Commit and push changes
3333
run: |
34-
git config --global user.name "github-actions[bot]"
35-
git config --global user.email "github-actions[bot]@users.noreply.github.com"
36-
git add package.json
37-
git diff --cached --quiet && echo "No version change." || git commit -m "chore(release): bump version [skip ci]"
38-
git push
34+
git config --global user.name "github-actions[bot]"
35+
git config --global user.email "github-actions[bot]@users.noreply.github.com"
36+
git add package.json
37+
if git diff --cached --quiet; then
38+
echo "No version change."
39+
else
40+
git commit -m "chore(release): bump version [skip ci]"
41+
git push
42+
VERSION=$(node -p "require('./package.json').version")
43+
git tag "v${VERSION}"
44+
git push origin "v${VERSION}"
45+
fi

‎CODE_OF_CONDUCT.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to a positive environment for our community include:
10+
11+
- Demonstrating empathy and kindness toward other people
12+
- Being respectful of differing opinions, viewpoints, and experiences
13+
- Giving and gracefully accepting constructive feedback
14+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
15+
- Focusing on what is best not just for us as individuals, but for the overall community
16+
17+
Examples of unacceptable behavior include:
18+
19+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
20+
- Trolling, insulting or derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or email address, without their explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Enforcement Responsibilities
26+
27+
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.
28+
29+
## Scope
30+
31+
This Code of Conduct applies within all community spaces and also applies when an individual is officially representing the community in public spaces.
32+
33+
## Enforcement
34+
35+
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.
36+
37+
## Attribution
38+
39+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.

‎CONTRIBUTING.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contributing to smart-todo-action
2+
3+
Thank you for considering contributing to **smart-todo-action**! We welcome pull requests and issues.
4+
5+
## Development Setup
6+
7+
1. **Install dependencies**
8+
```bash
9+
yarn install
10+
```
11+
2. **Run tests**
12+
```bash
13+
yarn test
14+
```
15+
3. **Run the linter**
16+
```bash
17+
yarn lint
18+
```
19+
20+
## Pull Requests
21+
22+
- Fork the repository and create a new branch for your change.
23+
- Write tests for new functionality whenever possible.
24+
- Ensure `yarn test` passes before submitting.
25+
- Provide a clear description of your change in the PR body.
26+
27+
## Code Style
28+
29+
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.
30+
31+
## Reporting Issues
32+
33+
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:
34+
35+
- Personal: <[email protected]>
36+
- Professional: <[email protected]>
37+
38+
## Code of Conduct
39+
40+
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.

‎README.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ jobs:
6363
llm-provider: openai # or 'gemini'
6464
```
6565
66+
See the [examples](examples/) directory for a complete workflow configuration.
67+
6668
Set `OPENAI_API_KEY` or `GEMINI_API_KEY` secrets based on your chosen provider.
6769

6870
### 2. Run the CLI locally
@@ -181,3 +183,25 @@ yarn check-version
181183

182184
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.
183185

186+
## 👤 Author
187+
188+
This project is maintained by [Diogo Ribeiro](https://github.com/DiogoRibeiro7).
189+
190+
- **ORCID:** [0009-0001-2022-7072](https://orcid.org/0009-0001-2022-7072)
191+
- **Affiliation:** ESMAD - Instituto Politécnico do Porto
192+
- **Personal email:** <[email protected]>
193+
- **Professional email:** <[email protected]>
194+
195+
196+
## 🤝 Contributing
197+
198+
We welcome contributions! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines and make sure to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
199+
200+
## 💬 Community Support
201+
202+
If you need help or want to discuss ideas, join our community spaces
203+
([details](SUPPORT.md)):
204+
205+
- [GitHub Discussions](https://github.com/DiogoRibeiro7/smart-todo-action/discussions)
206+
- [Discord](https://discord.gg/smart-todo-action)
207+

‎ROADMAP.md‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,24 @@ A smart GitHub Action that detects, classifies, and transforms inline TODOs into
5757
> Make it fast, reliable, and easy to adopt across the community.
5858
5959
- [ ] Plugin-based architecture (LLM integration, reporters, etc.)
60-
- [ ] CLI mode (run locally or in CI/CD)
60+
- [x] CLI mode (run locally or in CI/CD)
6161
- [ ] >90% test coverage
6262
- [ ] Full documentation & usage guides
6363
- [ ] Publish to GitHub Marketplace
6464

6565
---
6666

67+
## 🫂 Phase 6: Community Engagement
68+
69+
> Foster an active ecosystem and support network.
70+
71+
- [x] Contributor guidelines and code of conduct
72+
- [x] Example workflows and tutorials
73+
- [x] Discussion board or Discord for support
74+
- [ ] Regular release announcements
75+
76+
---
77+
6778
## 📌 Notes
6879

6980
- Built with extensibility and automation in mind.

‎SUPPORT.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# 💬 Community Support
2+
3+
Join the discussion board to get help, share ideas, and connect with other users.
4+
5+
- **GitHub Discussions:** [DiogoRibeiro7/smart-todo-action Discussions](https://github.com/DiogoRibeiro7/smart-todo-action/discussions)
6+
- **Discord:** [https://discord.gg/smart-todo-action](https://discord.gg/smart-todo-action)
7+
8+
Feel free to open a topic if you have questions or need assistance.

‎examples/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Example Workflows
2+
3+
This directory contains sample configurations demonstrating how to use **smart-todo-action** in your own projects.
4+
5+
- [`todo.yml`](todo.yml) – Minimal workflow that installs dependencies and runs the action on each push to `main`.
6+
7+
Feel free to copy and adapt these files to suit your needs.

‎examples/todo.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Smart TODO Action Example
2+
3+
on:
4+
push:
5+
branches: [main]
6+
7+
jobs:
8+
smart-todo:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
issues: write
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Setup Node.js
15+
uses: actions/setup-node@v4
16+
with:
17+
node-version: 20
18+
- run: yarn install
19+
- run: yarn prepare
20+
- name: Run Smart TODO Action
21+
uses: DiogoRibeiro7/smart-todo-action@v1
22+
with:
23+
repo-token: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)