philippedeb / susie Goto Github PK

Description

For big repositories, the colors in the Contributors metric break (missing/black) in the table and piechart. This happens due to the colors being mapped to contributors before sorting, which results in indexing problems when later converting to a top-n contributor and "Other" category. To fix this issue, colors should be mapped after these categories have been formed and % should be used to prevent any out-of-index bugs.

Reproduction URL

https://philippedeb.github.io/susie/dashboard?search=github.com/streamlit/streamlit

Reproduction steps

1. Go to 'https://philippedeb.github.io/susie'
2. Search for a big repository with many contributors, e.g. 'github.com/streamlit/streamlit'
3. Scroll down to 'Contributors' and click the piechart dropdown
4. Broken colors in table and piechart are visible (missing or black)

Screenshots

Description

We want to perform sentiment analysis on the issues of a GitHub repo with the idea of individual sustainability.

Reference Issues

No response

Implementation PR

No response

Description

When searching for a repository on mobile [iPhone, Safari], submitting a query using the search button does not work. Most likely, the state has not been updated to the text that just has been inputted. It only seems to work when Enter/Return on the keyboard is hit, then the keyboard closes and it searches immediately. The expected behaviour would be to also be able to hit the search button in the GUI while typing and then going to the dashboard.

Reproduction URL

https://philippedeb.github.io/susie/

Reproduction steps

1. Go to 'https://philippedeb.github.io/susie/'
2. Click on 'Enter Github Repository URL' [searchbar input field in Analysis tool]
3. Type a repository, e.g. 'https://www.github.com/philippedeb/susie', do not close keyboard
4. Click the Search icon (don't hit 'Return' on keyboard, this works)
5. Warning will show up: 'The URL must be in the format ...' instead of going to the dashboard

Screenshots

No response

Logs

No response

Browsers

Safari

OS

No response

Description

Using geolocation data from GitHub comments can provide an indication of the contributor diversity working on a repository. A high diversity of contributors can lead to a more inclusive product.

Reference Issues

None

Implementation PR

None

• Write motivation for sustainable SE
• Write problem analysis (very important!)

Description

The repo needs a code of conduct before it goes open source. This should be added in CODE_OF_CONDUCT.md in the .github folder.

Reference Issues

Duplicate of #34, that one is closed because it didn't use this template.

Implementation PR

No response

~ ISSUE_TEMPLATE.md

Description

Instead of having experimental metrics (e.g. suboptimal accuracy or non-evident purposes) in the dashboard, which may influence end-users to believe the site is less credible, it could be split up as follows:

• Dashboard, only the prominent metrics are listed
• Button 'See experimental metrics' at the bottom - expands to show the dashboard as per usual with everything, but end-users are more aware of the distinction

Important: also reflect this update on the section menu sidebar

Implementation PR

#51

Description

The sentiment analysis is fundamental and not specified towards the language used in GitHub issues. Most of the time it will not consider the context of a word which results in inaccurate scores. Additionally, it only takes the issue title as input and does not look at comments or descriptions which can say a lot about the sentiment around an issue and thus about the individual sustainability of the developers working on the issue.

It would be an idea to get the data of the comments and descriptions as well as create a better ML model that gives more accurate sentiment scores.

Reference Issues

#40

Implementation PR

No response

Description

Two high vulnerabilities need to be patched. Does not seem to pose a high threat to our repository as of yet, but of course should be fixed.

Reproduction URL

https://github.com/philippedeb/susie/security

Reproduction steps

See /Security tab

Screenshots

No response

Logs

No response

Browsers

No response

OS

No response

• Quick overview
• Installation guide
  etc.

• Add Sources

Description

Dockerfiles can give us quite some insight into energy consumption. Interesting aspects are:

• Image size
• Resource utilization
• Image build time
• Dependencies

Reference Issues

None

Implementation PR

None yet

• MOSCOW
• Other useful ones

• Create github data fetching onclick
• Get last updated data
• Analyse all commit data

• Find resource for programming language analysis
• Implement language analysis through Git Rest API

Description

This issue describes who works on what for the report:

1. Introduction (@merelanne)
2. Proposal (@merelanne)
   2.1 Metrics (Everybody)
   2.2 Guides (@izagorac)
3. Implementation (@philippedeb)
4. Validation
5. Social Impact (@Sebastien1999)
6. Conclusion (@philippedeb)
7. Discussion (Everybody)
8. Future Work (Everybody)

Reference Issues

No response

Implementation PR

No response

~ PULL_REQUEST_TEMPLATE.md

• Check slides for inclusivity checks in programming
• Implement one initial check for inclusivity -> check master/main branch
• Implement checks for branches
• Implement checks for commits
• Implement checks for pull requests
• Implement checks for issues
• Implement a "since" date option for commits and issues when fetching the data
• Implement a way to fetch a certain amount of commits based on pages
• Check possible other sources for inclusivity checks

Description

In the contributing guidelines, we use some non-inclusive language

Reproduction URL

https://github.com/philippedeb/susie

Reproduction steps

1. Go to https://philippedeb.github.io/susie/
2. Enter https://github.com/philippedeb/susie in the search bar
3. Click on search
4. See which word is the problem and what suggestions are made to replace it

Screenshots

Logs

No response

Browsers

Firefox

OS

Windows

• Input author names
• Make table of contents
• Add (sub)section headers
• Create bibtex file with first few sources

Description

I'd suggest changing to the more efficient pnpm in favor of npm, since this project is (also) about environmental impact.

Reference Issues

No response

Implementation PR

No response

Description

Currently, Susie only detects .md files for Issue templates, but the new way to have issue templates in GitHub is using .yml files. This even means that the issue templates in Susie's own repo are not detected.

Reproduction URL

https://github.com/philippedeb/susie

Reproduction steps

1. Go to https://philippedeb.github.io/susie/
2. Enter https://github.com/philippedeb/susie in the search bar
3. Click on search
4. See that the issue template is not detected

Screenshots

Logs

No response

Browsers

Firefox

OS

Windows

~ CHANGELOG.md

Add a release when we go open source!

Description

In the Governance metric, check whether the repository has a site.
Additionally, perhaps in a different metric/component, calculate the amount of carbon the website emits using various tools, e.g.:

• npm packages such as https://www.npmjs.com/package/website-carbon-calculator
• APIs/websites such as https://www.websitecarbon.com/

Reference Issues

No response

Implementation PR

No response

Description

The current home page is rather simple, yet functional. The home page should be designed similarly to state-of-the-art websites in the field of sustainability. Nature color palette, earthy font, etc.

Reference Issues

No response

Implementation PR

No response