kubbot
commented
1 year ago This issue is available for anyone to work on. Make sure to reference this issue in your pull request. :sparkles: Thank you for your contribution! :sparkles:
Join slack 🤖 to connect and communicate with our developers.
If you wish to accept this assignment, please leave a comment in the comments section: /accept.🎯
Introduction
This design document outlines the process of resolving linting issues across three critical repositories: Openim Server, Core, and Chat. The errors are identified using the "make lint" command, and the goal is to rectify them for cleaner, efficient, and error-free codebases.
The tasks will be subdivided according to the repositories, focusing on specific directories within each. The primary targets are the
/pkgand/internaldirectories in both Chat and Server repositories, along with all other directories outside these two.Install make lint tools:
Task Breakdown
We'll divide this work into six modules, two each for the Chat and Server repositories, and one for each "other" directory in these two repositories. Here's how we would partition the work:
1. Chat Repository -
/pkgDirectoryPR Link:
In PR, replace Fixed with the following way of linking:
2. Chat Repository -
/internalDirectoryPR Link:
In PR, replace Fixed with the following way of linking:
3. Chat Repository - Other Directories
PR Link:
In PR, replace Fixed with the following way of linking:
4. Server Repository -
/pkgDirectoryPR Link:
In PR, replace Fixed with the following way of linking:
5. Server Repository -
/internalDirectoryPR Link:
In PR, replace Fixed with the following way of linking:
6. Server Repository - Other Directories
PR Link:
In PR, replace Fixed with the following way of linking:
Workflow
The workflow for each of these tasks would involve the following steps:
make lintcommand to identify all linting errors.make lintcommand again to verify if all linting errors are resolved.This strategy ensures a systematic and efficient process to resolve linting errors, improve the code quality and maintainability. It will be necessary to prioritize these tasks based on their impact on the overall projects and business requirements.