reposense / reposense

Contribution analysis tool for Git repositories

RepoSense

RepoSense is a contribution analysis tool for Git repositories. It is particularly useful for those who want a chronological visualisation of the code contributions and commits made to a group of repositories. Educators can use RepoSense to track the work done in class projects, while team leads may use it to oversee their project teams.

• User documentation i.e., if you are interested in using RepoSense
  • Product website
  • User guide
  • About us
• Developer documentation i.e., if you are interested in contributing code to RepoSense
  • Developer guide
  • User Guide for the latest master (not yet released to users)

---

Our Contributors :

Acknowledgements: The web previews of RepoSense is powered by Netlify and Surge.

reposense's Issues

Show more details of the current author

Details shown on the code panel can be same as the details shown in the name list on the left, for easier matching. But it is ok to show the github username in addition.

Ramp chart: explore color options

Can post a screenshot of ramp chart that uses only one color for all ramps, e.g., red?

Stray space in console output

Minor issue but best to fix as this is seen by user.

Make author name look clickable

The current version doesn't look clickable. i.e., mouse icon doesn't change when hovering over.

Also, we can add a small icon to the end of the name to give a target for the user to click.

124. CS2103JAN2018-W10-B4/main/NG JU...N WEI ▶️

Support multiple repos for one author

In some projects/courses, students work on multiple repos. It is nice to be able to aggregate activities of a student on multiple repos in one chart.

Note: this feature is unlikely to be in v1, but keep this in mind when making architectural decisions.

Report: code view: show a spinner while the code is loading

As the code can take some time to load, it may be better to show a spinner or loading ... while the code is being loaded.

Optimize vertical spacing

We can compact some more, in these areas:

The font size used for the name can be smaller too.

File name with spaces

CommandRunner has trouble processing file name with spaces. Need to add escape character. Note: Windows and UNIX have different escape characters.

Weird Git-related bug under windows

I have problem analyzing one specific repo when I run the app in Windows, in UNIX this problem doesnt appear.
https://github.com/CS2103AUG2017-W09-B4/main
^ this is the repo.
When I run Git Clone on this repo, the program will hang. When I run Git Clone on this repo in my Windows PowerShell, it hangs too...:(
@damithc May I ask whether you are able to run the app on your Windows machine?

Code display: collapse 'untouched' code

We can reduce the scrolling needed if there is a way to collapse code segments that are not touched by the author, for example, similar to how GitHub diff view does it.

Show authors without any contributions

Are we showing authors who don't have any contributions? If not, we should, as those are the cases that need tutor attention.

Rename gitgrader --> reposense

Some of the files in the repo are still named as gitgrader

Automate publishing the report

When this is being used for real, I expect we need to update the report at least daily. It would be nice if there is a way to automate that. Minimally a script that we can run manually (or schedule using the OS).

Sort order: team name --> repo

It's more accurate to say sort by Repo ?

Repo names, use / instead of _

As underscore is allowed in repo and org names, it makes more sense to use org/repo format than org_repo format.

Report page: tweak spacing between filters

The first space should be smaller than the second one.

Highlighted author becomes invalid when the sorting changes

If I change the sorting/grouping, the highlighted author is incorrect.

Report: add padding on the right

Adding a little padding on the right (similar to left) makes it easier on the eye. Otherwise it looks like part of the chart is hidden.

Code view: cosmetic tweaks to panel headings

Things to try:

• smaller font
• a more subdued background color
• no border (in fact, try getting rid of all border lines everywhere in the code view. They are visual clutter that we can do without, in most cases)

vs

Ramp size is proportional to LoC

These 4 appear the same size but the LoC of them are vastly different. The size is proportional to what? LoC or something else?

Show total time after batch processing

It would be useful to see the total time taken after running the CLI command.

How does sorting work when grouped by team?

When grouped by team, do you sort based on a total value for the whole team?

No ramps shown for author

I thought there should be some ramps for this guy?

Choice of unique identifier for authors

In the current implementation, I used Github ID as the unique identifier, which means that students have to set their author name in local .gitconfig to their Github ID.
After asking a few of my friends and observation from dogfood test, it seems that most of the students prefer to customize their author name, and are reluctant to change it to their Github ID. However, they are okay with setting their local author EMAIL to their Github email. In fact, most of them seem to do so already.
It is better if we check for both author email and name in analyzer, and see match whichever we can. (Need to check whether its possible, if not possible, matching email is still a better solution than matching Github ID)

Support a cli command to run the app

It's good if we can have a cli equivalent.

e.g.,
gitgrader --config repos.csv --output ./output

Rushiness -> Consistency

We can name it 'Consistency'. Low consistency means high variance.

Omit dates from bookmark URL

I'm not sure if we should include the start/end dates in the bookmark URL. The dates are likely to change as the page is updated regularly while the bookmark should remain fixed over the semester.

Possible names for the tool

I'd rather not have 'Grader' in the name as the tool doesn't do any grading, plus grading has negative connotations. No idea for a better name though. Some of the good names seems to have been taken already.

Search: do an OR search rather than an AND search

Doing an OR search will allow tutors to filter all their teams e.g., F09-B4 F09-B3 should show both teams rather than no teams

Code view: give a button to expand/collapse all

It can be useful to be able to expand/collapse all code panels

Show date as dd/mm/yyyy

The format used in the CLI command is dd/mm/yyyy. We should use the same format in the report.

Tidy up UI controls for view config parameters

This part can be tidied/polished up to make a good first impression. Also, may want to optimize the layout like a nav bar at the top of the page (to save vertical space).

Ramp chart: selection doesn't work after search feature is used

Steps:

1. Search for a keyword
2. Clear keyword and press enter -> full list is shown
3. Click on a name

Expected: load the code of that person
Actual: nothing happens

Support sort by repo, name

When used for grading, it is also useful to sort by repo, student name

Grey out the code of others, not the owner's

Currently, we use a grey background to indicate lines written by the student, which makes those lines harder to read. Perhaps we should grey out the rest of the lines instead?

Show some untouched for to provide context

Suggestions:

Similar to how GitHub does it, we can show top and bottom n lines of the untouched-code to provide context for the touched-code. That also means collapse only chunks that are longer than 2n.

Build failure: analyzer.FileAnalyzerTest

OS: Windows 10
At ac9ac8d

analyzer.FileAnalyzerTest > allFileTest FAILED
java.lang.AssertionError at FileAnalyzerTest.java:26

Possible name for the visualization

The visualization reminds me of sail boats. Perhaps we can refer to the chart as the 'sail boats' chart. :-p

Move search bar to top row

This can save vertical space

You can also shorten/remove some of the labels to save space. e.g.,
Time interval: [daily] Start date: [] End date: [] can be period: [ ] - [ ] (daily)

Allow bookmarking by filter

e.g., https://harryggg.github.io/index.html?search=f11B3&interval=daily

That way, tutors can create a filter for their teams (and the view they want to see) and bookmark it.

Code view: give statistics at the top

We can show a table of stats e.g.,

File	LoC modified	% of file modified
a/b/c/Tag.java	5	12%
a/b/c/List.java	15	100%

Or this info can be in the panel heading of each file so that you can see a summary by collapsing all panels.

Collapsed chunks: cosmetic tweaks

Collapsed chunks should not attract too much attention
Things to try:

• Remove boarder
• Use grey, non-bold text
• Use a glyphicon or symbols instead of text e.g.,

  ← · · · →

Copy bookmark URL to address bar

May be easier to bookmark if the url is copied to the URL bar rather than clipboard (or both)? Not sure about this though.

Bookmarking: use a smaller icon

This one is attracting more attention than it should. Smaller, less conspicuous icon?

Chart: daily view: tool tip: show just one date

In the daily view of the chart, the tooltip is shown as day1 to day2. We can show only one date instead.

On a related note, these dates/times are based on what time zone?

Report: fix overlap of 'collapse' icon

Alternatively, you can use a ❌ icon at the right corner.

Use a different color for highlighting author

Use something other than grey? light yellow for example?

Number the student list

If you number the student list, it is easier to see how many students are being shown in the report.

Ramp chart: optimize vertical space further

Red lines can be moved closer to the main bar.
Names can be as small as font size of code (but can show in bold)

Generate collated files

It would be useful for the tool to spit out the collated code as one file per person (similar to the collate tool) so that this tool completely replaces collate.