Serendipity2-0 / TradeManV1

0 stars 0 forks source link

Refactoring, Documentation and CI CD implementation #51

Open Serendipity2-0 opened 1 month ago

Serendipity2-0 commented 1 month ago

Title: Project Documentation and Refactoring

Description: This document serves as a comprehensive guide for managing project documentation and refactoring processes. It outlines the necessary steps and guidelines for developers to follow from the initiation of an issue to the closure of a pull request. Additionally, it provides specific instructions for handling AI-related projects, including the integration of coding conventions and the utilization of AI prompt templates to enhance service outcomes. The refactoring section details the strategies for improving code quality across all packages, streamlining project components, and maintaining up-to-date and informative documentation.

Documentation:

1.  Project Developer Guideline: Includeing GitHub Projects Workflow (Flow from creating issue to closing PR)
2.  AI Project guide : A file to upload to any AI service to make it understand the coding conventions of our project
3.  AI Prompt templates : Sample prompt templates to get best results from AI services    

Refactoring:

•   Refactor All Packages: Conduct a thorough review and refactor all existing packages for improved code quality, readability, and performance.
•   Deprecate Streamlit Packages: Identify and deprecate Streamlit packages that are no longer necessary or being used.
•   Remove Unnecessary Documents: Remove unused .md files and other unnecessary files
•   Write a Good README File: Develop a comprehensive and well-structured README file that provides clear information about the project, setup instructions, usage, and contribution guidelines.

CI-CD Implementation:

    •      Login Test
•   Order placement for strategies (Configurable)

This will be an ongoing issue till Aug 15th. We will be using mkdocs to host this on github with more docs to be added

amolkittur commented 2 days ago

@omkarh25 Are there any tasks pending in this issue or should i close the issue ?