-
Notifications
You must be signed in to change notification settings - Fork 304
Description
Overview
I would like to propose the addition of detailed contribution guidelines to the TDesign project. While the README provides a good overview of the project and its components, having a dedicated section or a separate document that outlines the steps for contributing to the project would be beneficial for both new and experienced contributors.
Current Situation
Currently, there is no clear guidance on how to submit issues, pull requests, or the coding standards and practices to follow when contributing to the project. This may discourage potential contributors who are unfamiliar with the contribution process.
Suggested Improvements
- Contribution Process: Outline the steps for submitting a pull request or reporting an issue.
- Coding Standards: Include any specific coding guidelines or best practices that contributors should follow.
- Testing Guidelines: Provide information on how to run tests and ensure contributions do not break existing functionality.
- Communication Channels: List any platforms (e.g., Slack, Discord, GitHub Discussions) where contributors can ask questions or seek help.
Benefits
By adding detailed contribution guidelines, TDesign will likely see an increase in contributions, making it easier for new developers to get involved and for existing contributors to adhere to established practices. It will also enhance the overall developer experience.