search

reposense / RepoSense

Contribution analysis tool for Git repositories
https://reposense.org
MIT License
238 stars 153 forks source link

[#2170] Add Blurbs for Repos #2191

Closed asdfghjkxd closed 2 months ago

asdfghjkxd commented 2 months ago

Part of #2170

Proposed commit message

Currently, there are no ways for student developers to append messages
for each of the repositories they would like to showcase using
RepoSense.

Let's move to implement a blurbs feature to allow individual student
developers to showcase their contributions to their project.

Other information

This feature requires Java 11 CI/CD to be implemented.

asdfghjkxd commented 2 months ago

@sopa301 Let me work on that and update you in the upcoming days!

asdfghjkxd commented 2 months ago

@sopa301 I have implemented new test cases for BlurbMap, please do let me know if there are any other aspects that are lacking in tests!

asdfghjkxd commented 2 months ago

@gok99 @ckcherry23 I have added the new changes as requested!

github-actions[bot] commented 2 months ago

The following links are for previewing this pull request:

damithc commented 2 months ago

Thanks @asdfghjkxd for this PR, and @ckcherry23 @gok99 @sopa301 for the reviews/guidance. 💯

ckcherry23 commented 2 months ago

Hi prof @damithc, I merged the PR without giving co-author credit to @sopa301 by mistake, but both @asdfghjkxd and @sopa301 were authors of this PR.

damithc commented 2 months ago

Hi prof @damithc, I merged the PR without giving co-author credit to @sopa301 by mistake, but both @asdfghjkxd and @sopa301 were authors of this PR.

Noted @ckcherry23 Thanks both @asdfghjkxd and @sopa301

damithc commented 1 month ago

@asdfghjkxd @sopa301 Which folder should contain the blurbs.md? I tried both assets and configs folders with this file, but couldn't get it to show up in the dashboard.

sopa301 commented 1 month ago

Hi prof @damithc , the link should be the link to the branch instead of to the repo (because multiple branches from the same repo can be displayed). For example, https://github.com/AY2324S2-CS2103-F08-2/tp/tree/master instead of https://ay2324s2-cs2103-f08-2.github.io/tp/

If you want to configure the blurbs.md to point to the main/master branch if the repo link is specified, we can open an issue for it.

damithc commented 1 month ago

Hi prof @damithc , the link should be the link to the branch instead of to the repo (because multiple branches from the same repo can be displayed). For example, https://github.com/AY2324S2-CS2103-F08-2/tp/tree/master instead of https://ay2324s2-cs2103-f08-2.github.io/tp/

@sopa301 Ah, I see. I missed that part. It's working now after I added the branch. Thanks for the clarification.

If you want to configure the blurbs.md to point to the main/master branch if the repo link is specified, we can open an issue for it.

I guess no need. It's not too much extra work to specify the branch.

damithc commented 1 month ago

Feature in action https://nus-cs2103-ay2324s2.github.io/tp-dashboard