diff --git a/EXAMPLE.md b/EXAMPLE.md new file mode 100644 index 00000000..76621ef7 --- /dev/null +++ b/EXAMPLE.md @@ -0,0 +1,11 @@ +# Example Usage + +This is a simple example file to demonstrate a PR creation and CLA signing process. + +## Quick Start + +1. Install DeepWork: `pipx install deepwork` +2. Initialize in your project: `deepwork install --platform claude` +3. Start using jobs: `/deepwork_jobs.define` + +For more information, see the [README](README.md). diff --git a/PR_INSTRUCTIONS.md b/PR_INSTRUCTIONS.md new file mode 100644 index 00000000..6849064f --- /dev/null +++ b/PR_INSTRUCTIONS.md @@ -0,0 +1,51 @@ +# Pull Request and CLA Signing Instructions + +## Summary + +✅ **Task Completed (Partially)**: PR #107 has been successfully created +❌ **Limitation**: Cannot programmatically add comment due to GitHub API write access restrictions + +## PR Status + +✅ **Pull Request Created**: PR #107 has been successfully created with the branch `copilot/create-simple-pr` +- **Changes**: Added EXAMPLE.md file with basic usage documentation +- **PR Link**: https://github.com/Unsupervisedcom/deepwork/pull/107 + +## Limitation + +The AI agent cannot directly add comments to GitHub PRs because: +- No GitHub API write access credentials are available in the environment +- The `gh` CLI is not authenticated +- The GitHub MCP tools only provide read access to GitHub data +- Manual intervention is required to complete the CLA signing + +## Next Step: CLA Signature + +To complete the CLA signing process, please add the following comment to PR #107: + +``` +I have read the CLA Document and I hereby sign the CLA +``` + +### How to Add the Comment + +1. Visit the PR: https://github.com/Unsupervisedcom/deepwork/pull/107 +2. Scroll to the bottom of the PR page +3. In the comment box, type: `I have read the CLA Document and I hereby sign the CLA` +4. Click "Comment" to submit + +### What Happens Next + +Once you add the comment: +- The CLA Assistant bot will automatically detect your comment +- It will update the CLA_SIGNATORIES.md file with your signature +- The CLA check will pass, allowing the PR to be merged + +### CLA Document + +You can review the full CLA document at: +https://github.com/Unsupervisedcom/deepwork/blob/main/CLA/version_1/CLA.md + +## Note + +The Copilot bot user that created this PR may be exempt from CLA signing requirements based on the allowlist in `.github/workflows/cla.yml`. However, the comment should still be added as requested to demonstrate the complete workflow.