docs: add comprehensive contributing guidelines with TDD requirements#129
docs: add comprehensive contributing guidelines with TDD requirements#129CurroRodriguez merged 7 commits intomasterfrom
Conversation
Add detailed CONTRIBUTING.md file that includes: - Development setup instructions with uv dependency manager - Test-Driven Development (TDD) workflow and requirements - Mandatory unit testing requirements with 75% minimum coverage - Code quality standards and Python style guidelines - Pull request process and commit message conventions - Bug reporting and enhancement suggestion templates - Documentation guidelines and community resources Emphasizes TDD approach as a core requirement and makes it clear that all contributions must include appropriate unit tests. Links to uv installation page to support all operating systems.
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive contributing guidelines that formalize the project's development workflow, with a strong emphasis on Test-Driven Development (TDD) and quality standards.
Purpose: Establish clear contribution guidelines to help new and existing contributors understand the development process, testing requirements, and code quality expectations for the Bolt task automation project.
Key Changes:
- Adds detailed CONTRIBUTING.md with TDD workflow requirements and 75% minimum test coverage mandate
- Documents development setup using uv dependency manager
- Provides code examples, testing guidelines, and commit message conventions
- Removes placeholder .github/CONTRIBUTING.md file
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | Comprehensive new contributing guide covering development setup, TDD workflow, testing requirements (75% coverage minimum), coding standards, PR process, and community guidelines |
| .github/CONTRIBUTING.md | Removed placeholder file in favor of the new root-level CONTRIBUTING.md |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
@CurroRodriguez I've opened a new pull request, #130, to work on those changes. Once the pull request is ready, I'll request review from you. |
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Minimum allowed line rate is |
1 similar comment
Minimum allowed line rate is |
Minimum allowed line rate is |
|
@CurroRodriguez I've opened a new pull request, #131, to work on those changes. Once the pull request is ready, I'll request review from you. |
|
@CurroRodriguez I've opened a new pull request, #132, to work on those changes. Once the pull request is ready, I'll request review from you. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Minimum allowed line rate is |
1 similar comment
Minimum allowed line rate is |
Minimum allowed line rate is |
2 similar comments
Minimum allowed line rate is |
Minimum allowed line rate is |
Summary
Add detailed CONTRIBUTING.md file that includes:
Emphasizes TDD approach as a core requirement and makes it clear that all contributions must include appropriate unit tests. Links to uv installation page to support all operating systems.