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

Guidelines for Module Leaders and Proposal for Contribution Process #32

Open
waterflier opened this issue Aug 18, 2023 · 0 comments
Open

Comments

@waterflier
Copy link
Collaborator

Dear all,

Firstly, I want to express my heartfelt thanks to all those who have shown interest and left comments in the issue about becoming module leaders of MVP . Your support is invaluable!

Currently, OpenDAN does not have a well-defined contribution process guideline. I believe we need to establish this soon, but it should be a collaborative effort, developed through our collective discussions and experiences. From my perspective, I would like potential module leaders to open a separate issue outlining their general module design after their application. This can be viewed as a project proposal. This way, we can focus all pre-coding discussions for a module in one place. Additionally, this is a necessary process step required by the SourceDAO project management contract.

I think a project proposal should include the following sections:

  1. Basic Information: Including the project leader.
  2. Difficulty Level: I have set some, but if you have different opinions, please suggest modifications. Objective discussions about difficulty directly relate to the project's expected completion time and expected DAO Token rewards.
  3. Team (optional): If you plan to invite more friends to complete this project together, you can state it here.
  4. Project Goals: Briefly explain the core objectives of the project.
  5. Key Project Processes: You can explain this using interface definitions or pseudocode.
  6. Testing Methods: This is essential. Describe how to write test cases for the module. This section will help everyone build a more unambiguous consensus.
  7. Project Architecture Design (optional): Draw important flowcharts, class diagrams, sequence diagrams, etc. I recommend using draw.io for this.

I am currently developing the pkg manager ,basic agent manager and agent template manage component, I will complete a document as an example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant