since-authorAdder

A GitHub plugin that adds since & author and description notes to all code files that miss it in a project Written originally by:

Raviv Rachmiel [email protected]

Yaakov Sokolik [email protected]

##Working with the program:

Working on a local repository:

You can use the program in order to add the since,author, description convention to your java code files by calling main.py with the path of the local git repository. The program will add the right @since, @author and descriptions needed exactly where they are needed to each file

Working on a Github repository:

You can use the program in order to add the since,author, description convention to your java code files by calling main.py with the URL of the repo, your username and your mail. The program will add the right @since, @author and descriptions needed exactly where they are needed to each file. Also, the program will clone automatically the repo to a temp directory, make the changes, commit them and push to the github repository (so you have to have the right privileges for the repo). At the end, it will delete the temp folder it cloned

##Usage: ###For a local git repo: python3 main.py ###for a Github repo: python3 main.py <user.name> <user.mail>

• the user.name has to be either 1 word, or a couple of words wrapped by ""
• the <user.name> and <user.mail> are for the commit info
• you have to have the right priviliges in order to push to the github repo of course

###Dependencies: We use:

• python3

• gitpython library:

    pip3 install gitpython
  

###Works for:

• Java

Enjoy :)