markgomer opened a new issue, #1120: URL: https://github.com/apache/age/issues/1120
**Is your feature request related to a problem? Please describe.** The onboarding process for new contributors to the Apache AGE project is challenging due to a lack of comprehensive documentation about the codebase, standards, and procedures. This makes it difficult for new developers to understand how they can best contribute to the project. Furthermore, the absence of a standard guide may lead to inconsistencies in code and practices across the project. **Describe the solution you'd like** I propose that we create a comprehensive Developer's Manual for the Apache AGE project. This document should provide: 1. An overview of the project structure and codebase to help newcomers understand the system quickly. 2. Our coding and documentation standards, best practices, and conventions to ensure consistency across the project. 3. Step-by-step procedures for common tasks like submitting pull requests, reporting bugs, or proposing new features. 4. Information about the project's vision, goals, and roadmap to ensure that all contributors are aligned in their efforts. **Describe alternatives you've considered** An alternative solution could be creating separate documents for each of the points mentioned above. However, having all the information in one comprehensive Developer's Manual would provide a central source of truth and would be more efficient for both new and existing contributors. **Additional context** Creating a comprehensive Developer's Manual would not only ease the onboarding process for new contributors but also enhance collaboration among team members. It would provide a shared understanding of the project and its goals, making the development process smoother and more efficient. As the project grows, this manual will be an invaluable resource to ensure consistency and quality in our collaborative efforts. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@age.apache.org.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
