longfangsong / Watchdog

[Planning] A tool to find out potential out-of-date comments

0 stars 0 forks source link

Plan #1

Open longfangsong opened 4 years ago

longfangsong commented 4 years ago

This is the future plan for this project.

Problems solved:

Which language shall we use? Python.
Which languages shall we support?
- Rust
- Go
- Python
- Any language reasonable except Java, we'll never ever ever ever ever support Java!!!
Do we need any static analyzing tool? Currently GitHub might be enough, and it can support all languages.
What statistic shall we take into consideration?
- Time Diff
- key words
  - return xxx
- [Future] Use an NLP tool. This should be done after we collect enough data.

Problems remaining:

How to store the analyzing config, eg. ignored files, and the data we collected?
- I hope we can find a place to store them for free.

longfangsong commented 4 years ago

Data collected for do the analyze

Currently we'll use github's blame page. We'll collect all BlameHunks and lines. (I'm not sure which is better for analyzing, raw text or the html code which is already syntax analized by Github?)