wxharry / github-repo-comparer

Hi there 👋

🌱 I'm currently working on .NET and React

🔭 I’m currently seeking opportunities in North America and China.

🎓 I'm a graduate student of NYU Courant.

👯 I'm working on some awesome ideas and would love you to join us.

📫 Feel free to reach me at [email protected]

🕛 I live in the Eastern Time Zone (EST: UTC-5)

github-repo-comparer's Issues

feat: implement vertical table

For current chart view, repos are listed in rows, it is not easy to read if we have a lot of measurements to compare. A vertical table could be better for comparing. This feature could be implemented in the card mode first then add a new view in char view

Feat: implement option page

The option page should be an overall settings page for the extension:

1. add and remove repo in repoList
2. Choose measurements users wanted to display in the views
3. Set language and themes
4. Input personal token for users to add his/her own private repo #17

bug: useless element on top of the web page

Description

A useless component is detected injected to the top of the web page. Not sure why it is there.

feat: themes needed

Dark/light themes are needed. Can refer to https://ant.design/components/config-provider#usage

CI/CD: source code not updated when push a new commit to master branch

Current workflow pushes the release version zip to the latest tag, but the tag is not updated. So the source code is not updated which is not expected.

feat: i18n needed

Need implement locale to grc, refer to https://docs.plasmo.com/framework/locales

feature: allow users to add their personal token to the extension

Enhancement: Add prettier to the project

We will need prettier to format the code

Things needed to be done before make this repo public

• Token issue. Token is needed for fetching repo data. At this stage, it is fine to use my personal token, I just need to set the privilege properly(read-only on public repos). It would be better if users can enter their own token in future version so that they can add private repos they have access to.
• Docs. Licesnces, contribution guide, readme #11
• Publish workflow. Need to improve the workflow to publish automatically, but it could be manual work at first stage anyway. Just need to publish it.

bug: Cannot recognize some links

Description

Cannot recognize links like https://github.com/tesseract-ocr/tesseract?tab=readme-ov-file

Sweep: Add keyboard binding to add current repo, open modal, and clear all data

Add keyboard binding to listen to the keyboard input, if user press key 'o', use the function to set the isModalOpen to true; if user press key 'a', use the following code to add the current repo to the repo list, you should use "github-url-detection" to get the repo info.

  const [repoList, setRepoList] = useStorage("repoList", (v) =>
    v === undefined ? [] : v
  )

Checklist

• Modify src/contents/modal/index.tsx ✓ c8e3ae4 Edit
• Running GitHub Actions for src/contents/modal/index.tsx ✓ Edit
• Modify src/popup/index.tsx ✓ 654be99 Edit
• Running GitHub Actions for src/popup/index.tsx ✓ Edit

ci/cd: need automation to build and release project

We need to use github actions to build and release the project to github release, so that users can download and add the extension manually. Publishing the extension is not included in this issue.

feat: table view for comparing repos

Add the chart view for comparison, this is the first feature, so we would need to implement the button, modal, and storage system. Would be a big one.

UI/UX: Better UI design and flow chart needed

Current design is default styles from ant design components which is normal to ugly. It would be better if we could have a differet design for front end.

feat: number format

Pure number is not easy to read, we need a number format function for displaying the figures. For example, round up 6783 to 6.8K to have a more formatted display on figures. We still need to show the numbers (by tooltip maybe) to give the exact numbers.

[feature] Add hot keys and remove the pop up page

The pop up page is ugly and is not making things simple. I am thinking of using hotkeys to replace functions in the pop up page.

• #27
• Remove the pop up page. Clicking on the icon opens the modal directly.
• Add buttons to the modal for adding current repo to the list.

feat: set a baseline in table view for better comparison

Table view is a good view for listing all measures needed for the repo. It would be better if we could set a baseline in the table view to have a better view of comparison.

docs: README is needed

What should be included in README

1. What is this project
2. Why I created this project
3. Future plans
4. Licence and contribution