Skip to content

martihomssoler/git-todos

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

git-todos

A simple tool that scans your git repo and generates a list of action items that you did not forget at all...

Executing it inside the git-todos repo will generate the following file (which you can find here).

TODOS

ABC

TEST

Installing

Using cargo install, installing git-todos is super easy.

git clone {git_todos_url}
cargo install --path .

Usage

To use git-todos just navigate to your desired git repo and execute it. A file named TODOS.md will be created, or modified if it already exists, and filled with a list of pending comments found in the repo.

For now the functionality is very limited. I use Regex expressions to search and match for a desired comment. Take a look at here and here for the regex and the TodoItem respectively.

Contributing

Feel free to open PRs with the desired changes. I will try to respond to all of them.

License

git-todos is licensed under the MIT license. See LICENSE.txt for more details.

About

A comment scanner for your repos.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages