Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactoring of the Bittensor codebase (Consider as a Epic) #1882

Open
4 of 7 tasks
RomanCh-OT opened this issue May 15, 2024 · 1 comment
Open
4 of 7 tasks

Refactoring of the Bittensor codebase (Consider as a Epic) #1882

RomanCh-OT opened this issue May 15, 2024 · 1 comment
Assignees
Labels
feature new feature added refactoring

Comments

@RomanCh-OT
Copy link
Contributor

RomanCh-OT commented May 15, 2024

Is your feature request related to a problem? Please describe.

The current Bittensor package lacks consistent coding standards across its various modules, which сan led to maintainability issues. This task card is for refactoring the Bittensor codebase to enhance readability, consistency, and adherence to modern Python practices.

Describe the solution you'd like

I am doing a sequential (module-based) refactoring of the Bittensor codebase. This includes ensuring compliance with Cortex standards, introducing type annotations for all functions and methods, and reorganizing the code structure to improve modularity and separation of responsibilities. This refactoring will also require updating all code documentation to reflect the changes and enhance clarity.

Special attention should be given to dividing the refactoring into:

  1. Refactoring according to RFC 003: Bittensor Coding Standards
  2. Structural and architectural changes, which will also require separate PRs.

Acceptance Criteria

  • Development of the Scope of Work (SOW) document
  • SOW is developed, listing the Bittensor package modules in order from the least used to the most complex.
  • The document should include a detailed plan that accommodates both current and planned changes, ensuring alignment with ongoing projects and future enhancements.
  • SOW Approval
  • The 'Scope of Work' document must be reviewed and approved by the development team and management to ensure that all stakeholders agree on the approach and priorities.
  • Feedback from the team and management should be incorporated to refine the refactoring plan.

Implementation Plan Update and Execution

@RomanCh-OT RomanCh-OT added the feature new feature added label May 15, 2024
@RomanCh-OT RomanCh-OT self-assigned this May 15, 2024
@RomanCh-OT
Copy link
Contributor Author

Added #1896 to list

@RomanCh-OT RomanCh-OT changed the title Refactoring of the Bittensor codebase Refactoring of the Bittensor codebase (Consider as a Epic) May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature new feature added refactoring
Projects
None yet
Development

No branches or pull requests

1 participant