Skip to content

Commit 5987e99

Browse files
committed
docs: add personal info to TODO
1 parent f17de64 commit 5987e99

File tree

8 files changed

+48
-7
lines changed

8 files changed

+48
-7
lines changed

.github/workflows/run_tests.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
name: Run Tests
22

33
on:
4-
push:
5-
branches: [main]
64
pull_request:
75
branches: [main]
6+
types: [closed]
87

98
jobs:
109
test:
10+
if: github.event.pull_request.merged == true
1111
runs-on: ubuntu-latest
1212

1313
steps:

.github/workflows/todo.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
name: Smart TODO Tracker
22

33
on:
4-
push:
4+
pull_request:
55
branches: [main]
6+
types: [closed]
67

78
workflow_dispatch:
89
inputs:
@@ -42,6 +43,7 @@ on:
4243

4344
jobs:
4445
smart-todo:
46+
if: github.event.pull_request.merged == true
4547
runs-on: ubuntu-latest
4648
permissions:
4749
contents: write

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,7 @@
2323

2424
## TODO · performance
2525
- Refactor this logic to improve performance (`src/testTodo.ts:2`)
26+
27+
---
28+
29+
For DOI and licensing details, see [CITATION.cff](CITATION.cff).

CITATION.cff

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
cff-version: 1.2.0
2+
message: "If you use this software, please cite it using the metadata from this file."
3+
title: "smart-todo-action"
4+
version: "1.0.0"
5+
repository-code: "https://github.com/DiogoRibeiro7/smart-todo-action"
6+
type: software
7+
url: "https://github.com/DiogoRibeiro7/smart-todo-action"
8+
date-released: 2025-06-19
9+
doi: "10.5281/zenodo.1234567"
10+
abstract: "GitHub Action that converts TODO comments into GitHub issues with optional LLM support."
11+
license: "MIT"
12+
keywords:
13+
- GitHub Action
14+
- automation
15+
authors:
16+
- family-names: Ribeiro
17+
given-names: Diogo
18+
orcid: "https://orcid.org/0009-0001-2022-7072"
19+
affiliation: "ESMAD - Instituto Politécnico do Porto"
20+

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
A GitHub Action that scans your codebase for inline TODOs, FIXMEs, and BUG comments, and automatically creates GitHub Issues — with support for labels, metadata parsing, and semantic enrichment.
44

5+
For citation information, see [CITATION.cff](CITATION.cff).
6+
57
---
68

79
## 🚀 Features
@@ -42,10 +44,10 @@ jobs:
4244
issues: write
4345

4446
steps:
45-
- uses: actions/checkout@v3
47+
- uses: actions/checkout@v4
4648

4749
- name: Setup Node.js
48-
uses: actions/setup-node@v3
50+
uses: actions/setup-node@v4
4951
with:
5052
node-version: 20
5153

@@ -174,3 +176,8 @@ current Git tag. It runs in CI and can be invoked locally with:
174176
```bash
175177
yarn check-version
176178
```
179+
180+
## 📜 Citation
181+
182+
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.
183+

TODO.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Personal Information
2+
3+
- **Name:** Diogo Ribeiro
4+
- **Username:** DiogoRibeiro7
5+
- **Personal email:** [email protected]
6+
- **Professional email:** [email protected]
7+
- **Affiliation:** ESMAD - Instituto Politécnico do Porto
8+
- **ORCID:** https://orcid.org/0009-0001-2022-7072

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: 'Smart TODO Action'
2-
description: 'Transforma comentários TODO/FIXME/BUG do código em GitHub Issues inteligentes.'
2+
description: 'Transforma comentários TODO/FIXME/BUG do código em GitHub Issues inteligentes. Consulte CITATION.cff para DOI e licença.'
33
author: 'Diogo Ribeiro'
44

55
inputs:

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"llm",
2323
"automation"
2424
],
25-
"author": "",
25+
"author": "Diogo Ribeiro <[email protected]>",
2626
"license": "MIT",
2727
"dependencies": {
2828
"@actions/core": "^1.10.0",

0 commit comments

Comments
 (0)