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

Create a Step-by-Step Guide for Creating a New Module #4

Open
5 tasks
WeiHuangWH opened this issue Oct 25, 2023 · 0 comments
Open
5 tasks

Create a Step-by-Step Guide for Creating a New Module #4

WeiHuangWH opened this issue Oct 25, 2023 · 0 comments
Assignees
Labels
doc Improvements or additions to documentation

Comments

@WeiHuangWH
Copy link
Contributor

WeiHuangWH commented Oct 25, 2023

This issue is aimed at creating a comprehensive documentation guide that will assist developers in creating a new module for our project. The guide will walk through the process step by step and provide all the necessary information and resources.

Issue Contents

To ensure the completion of the document, it is advisable to take into account several recommended aspects:

1. Image Collection

  • Gather all relevant images related to the new module development. These images will be used to visually illustrate various aspects of the process.

2. Folder Structure Introduction

  • Provide an overview of the folder structure that should be followed when creating a new module. This section will help developers understand where to place their files and resources.

3. Process Illustration with Example

  • Walk through the module creation process using a real-life example. This will include creating typical classes and methods, demonstrating how the designed framework works, and showcasing the key steps involved.

4. Procedure Description

  • Detail the necessary procedures that developers should follow when creating a new module. This will include step-by-step instructions, best practices, and tips for success.

5. Modified Files

  • List and describe the specific files that need to be modified during the new module development process. This will help developers understand the scope of changes required.
@WeiHuangWH WeiHuangWH self-assigned this Oct 25, 2023
@WeiHuangWH WeiHuangWH changed the title Creata a doc to introduce how to create a New Module step by step Create a Step-by-Step Guide for Creating a New Module Oct 25, 2023
@WeiHuangWH WeiHuangWH added the doc Improvements or additions to documentation label Oct 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant