Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 15, 2025

Summary

The TDD example in CONTRIBUTING.md referenced non-existent API patterns. Updated to reflect the actual Bolt Task implementation:

  • Task invocation: task(config)task(config=config)
  • Implementation methods: execute()_configure() and _execute()
  • Configuration access: Direct access → _require() helper
  • Test assertion: Removed non-existent Result return value, test configuration directly
# Before: Non-existent patterns
result = task(config)
assert result.success is True

class MyNewTask(Task):
    def execute(self):
        return Result(success=True)

# After: Actual Bolt API
task(config=config)
self.assertEqual(task.param, "value")

class MyNewTask(Task):
    def _configure(self):
        self.param = self._require("param")
    
    def _execute(self):
        pass

References


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

CurroRodriguez and others added 2 commits November 15, 2025 14:03
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.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: CurroRodriguez <1545531+CurroRodriguez@users.noreply.github.com>
Copilot AI changed the title [WIP] Update contributing guidelines and TDD requirements Fix TDD example in contributing guidelines to match Bolt Task API Nov 15, 2025
Copilot AI requested a review from CurroRodriguez November 15, 2025 19:19
Base automatically changed from docs/contributing-info to master November 15, 2025 19:28
@CurroRodriguez
Copy link
Contributor

Closing because the changes no longer apply.

@CurroRodriguez CurroRodriguez deleted the copilot/sub-pr-129 branch November 23, 2025 00:50
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

Successfully merging this pull request may close these issues.

2 participants