| title | version | lastUpdated | author | scope | type | tags | relatedDocs | changeLog | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Contributing to TextDAO |
0.1.0 |
2024-09-04 |
TextDAO Development Team |
project |
guide |
|
|
|
We're excited that you're interested in contributing to TextDAO! This document outlines the process for contributing to this project.
By participating in this project, you agree to abide by our Code of Conduct.
- Fork the repository and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
Bugs are tracked as GitHub issues. Create an issue on the repository and provide the following information:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible.
- Provide specific examples to demonstrate the steps.
Enhancement suggestions are also tracked as GitHub issues. When creating an enhancement suggestion, please include:
- A clear and descriptive title for the issue to identify the suggestion.
- A step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps.
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
- Run
bun lintto conform to our lint rules
For package-specific instructions, refer to the docs/development/coding-standards.md file in each package directory.
By contributing to TextDAO, you agree that your contributions will be licensed under its MIT License.