InetIntel / InetIntel/grip-ui

Repository cleanup

Open
#42 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation maintenance
Dominant language
JavaScript
Stars
0
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Given that there are a sizeable number of files in the repository at this point, there are a few measures that can be taken up for code maintainability:

  • Code restructuring: While we have a decent folder structure, I feel that further structure can be enforced (mainly within the src directory, for cleaner code segregation
  • Class/File renaming: Files have been using the a-b-c.jsx naming format, and certain functions and classes have names that are not informative enough. Shifting to a consistent camelcase format and making sure class names are informative would be imperative to solving this issue.
  • Removing unused files: There seem to be a lot of abandoned auth workflows, and certain pieces of dead code lying around. Cleaning these up would also be very helpful.
  • Conversion to functional components: A few components still use class-based structures, which can make the codebase harder to maintain and less consistent with modern React practices. Converting them to functional components would simplify state management, improve readability and help us use React hooks for cleaner logic separation.
  • Documentation: A simple documentation about the website's features in the readme might help contributors correlate between the features and the underlying code.
  • Code quality checks: Using tools such as Sonarqube to check code quality would be a good to have. This could be used by the devs on vscode, and integration into github's CI/CD pipeline could be looked into as well.

This can be a parent issue to discuss said matters, and since this cannot be resolved in 2-3 PRs, we can maintain this issue as a parent issue for further discussions, and create child issues that correspond to each of these larger issues.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No specific files or tests are named. Start by reviewing the src directory, abandoned auth workflows, the README, and the proposed GitHub CI/CD and SonarQube checks. Because this is a parent issue covering restructuring, renaming, cleanup, component conversion, documentation, and quality tooling, completion should be defined through separate child issues.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
ci-cd, documentation, frontend, tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
18/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.