ditkrg/todo-to-issue-action
4
0
Fork 0
mirror of https://github.com/ditkrg/todo-to-issue-action.git synced 2026-01-23 06:16:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

📝 feat(doc): add special case

Browse Source
This commit is contained in:
Bouteiller Alan 2020-07-09 10:28:32 +02:00
parent 5d27a9aad3
commit d88364e873
No known key found for this signature in database
GPG Key ID: EE8C5F9452E04F4E
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -96,6 +96,13 @@ Should you change the `# TODO` text, this will currently create a new issue, so
This may be updated in future.
### In an existing repo with existing todo
> This action will convert your `# TODO` comments to GitHub issues when a new commit is pushed.
Knowing that the todo are found thanks to the difference between the new commit and the previous commit this means that if this action is implemented during development the existing todo will not be taken.
They will have to be deleted, commit, put back and commit for it to be taken.
## Contributing & Issues
The action was developed for the GitHub Hackathon and is still in an early stage. Whilst every effort is made to ensure it works, it comes with no guarantee.