docs: add Issue First documentation for Cloud Agent integration #103
Conversation
- Add comprehensive Issue First.md explaining the Issue First approach - Adapt Roo Code Cloud documentation for Smartsheet Python SDK context - Include best practices for writing issues that work well with Cloud Agents - Provide examples of bug reports, feature requests, and documentation issues - Explain how Cloud Agents use issues as prompts to generate code changes
Reviewed commit 1411a18. Latest changes are markdown linting fixes only. All previously flagged issues have been resolved.
Mention @roomote in a comment to request specific changes to this pull request or fix all unresolved issues. |
![roomote[bot]](https://avatars.githubusercontent.com/in/1546624?s=60&v=4){kind=small}
| @@ -0,0 +1,296 @@ | |||
| # Issue First Approach for Smartsheet Python SDK | |||
There was a problem hiding this comment.
The filename Issue First.md uses a space, which is inconsistent with the repository's documentation naming convention. All other documentation files use hyphens or are single words (e.g., README.md, CONTRIBUTING.md, ADVANCED.md). Consider renaming to ISSUE-FIRST.md or ISSUE_FIRST.md for consistency and to avoid potential issues with tools that don't handle spaces in filenames well.
Fix it with Roo Code or mention @roomote and request a fix.
| ## What is "Issue First"? | ||
|
|
||
| The "Issue First" approach is a collaborative development methodology where **all contributions to the Smartsheet Python SDK must begin with a GitHub Issue** before any code changes are made. This means that whether you're fixing a bug, adding a new feature, or improving documentation, you first create or identify an existing issue that describes what needs to be done. |
There was a problem hiding this comment.
This document introduces an "Issue First" workflow that conflicts with the existing guidance in CONTRIBUTING.md. The current CONTRIBUTING.md states "Did you write a patch that fixes a bug? Open a new GitHub pull request with the patch," which suggests a code-first approach. This creates contradictory guidance for contributors. Consider either updating CONTRIBUTING.md to align with the Issue First approach or adding a clear statement in this document acknowledging the relationship between the two workflows.
Fix it with Roo Code or mention @roomote and request a fix.
| @@ -0,0 +1,296 @@ | |||
| # Issue First Approach for Smartsheet Python SDK | |||
There was a problem hiding this comment.
This new documentation file is not referenced anywhere in the existing documentation, making it difficult for contributors to discover. Consider adding a reference to this file in README.md (in the Documentation section) and in CONTRIBUTING.md (to explain the workflow). Without these links, contributors may not be aware of the Issue First approach or how to work with Cloud Agents.
Fix it with Roo Code or mention @roomote and request a fix.
Fixed the reported issue. Renamed the file to follow repository naming conventions. |
Fixed the reported issues. All local checks passed. |
…uidelines - Update CONTRIBUTING.md to require issues before all contributions - Add Issue First reference to README.md Contributing section - Resolve workflow conflicts between direct PRs and Issue First approach
|
@roomote there appears to be a number of linting issues in the new Issue-First.md as reported by github's linting check. Fix them. |
Fixed all markdown linting issues in ISSUE-FIRST.md. |
This PR adds comprehensive documentation explaining the Issue First approach for contributing to the Smartsheet Python SDK, specifically tailored for use with Roo Code Cloud Agents.
Changes
Issue First.mdfile with detailed explanation of the Issue First methodologyWhy This Matters
With Roo Code Cloud integration enabled for this repository, contributors can now leverage AI-powered Cloud Agents to help implement changes. A well-written GitHub Issue serves as a high-quality prompt that gives Cloud Agents the context needed to:
Documentation Structure
The new documentation covers:
This documentation will help both human contributors and Cloud Agents work more effectively together to improve the Smartsheet Python SDK.