Skip to content

CREATE_PR_GUIDE.md

Latest commit

 

History

History
129 lines (88 loc) · 3.4 KB

CREATE_PR_GUIDE.md

File metadata and controls

129 lines (88 loc) · 3.4 KB

How to Create the Pull Request

🚀 Quick Steps

Your changes have been pushed to your fork. Now create a PR to the upstream repository.

📋 Step-by-Step Instructions

Option 1: Via GitHub Web Interface (Recommended)

  1. Go to your fork on GitHub:

    https://github.com/Hahfyeex/Teye-Contracts

  2. You should see a banner saying:

    "master had recent pushes X minutes ago"

    Click the "Compare & pull request" button

  3. If you don't see the banner:

    • Click the "Contribute" button
    • Click "Open pull request"

  4. Fill in the PR details:

    Title:

    fix: resolve test compilation errors in zk_verifier, zk_voting, zk_prover, and identity

    Description: Copy the entire content from PR_DESCRIPTION.md file

  5. Add labels (if you have permission):

    • bug
    • documentation
    • testing

  6. Link issues: In the description, the following lines will auto-link:

    • Closes #273
    • Closes #272
    • Closes #271

  7. Request reviewers (if applicable)

  8. Click "Create pull request"

Option 2: Via GitHub CLI (if installed)

cd Teye-Contracts

gh pr create \
  --title "fix: resolve test compilation errors in zk_verifier, zk_voting, zk_prover, and identity" \
  --body-file PR_DESCRIPTION.md \
  --label bug,documentation,testing

📸 Before Submitting

Add Verification Screenshots

If you have cargo installed, run these commands and take screenshots:

# Screenshot 1: zk_verifier compilation
cargo check -p zk_verifier --all-targets

# Screenshot 2: All packages verification
./verify_all_tests.sh  # or .\verify_all_tests.ps1 on Windows

# Screenshot 3: Clippy checks
cargo clippy -p zk_verifier --all-targets -- -D warnings

Add these screenshots to the PR description in the "Verification Screenshots" section.

✅ PR Checklist

Before submitting, ensure:

  • Changes pushed to your fork
  • PR title is descriptive
  • PR description is comprehensive (use PR_DESCRIPTION.md)
  • Related issues are linked (Closes #273, #272, #271)
  • Verification screenshots added (if cargo available)
  • Reviewers requested (if applicable)
  • Labels added (if you have permission)

🔗 Useful Links

  • Your Fork: https://github.com/Hahfyeex/Teye-Contracts
  • Upstream Repo: (The original repository you forked from)
  • PR Description: See PR_DESCRIPTION.md in this directory
  • Documentation: See ALL_TEST_FIXES_SUMMARY.md for complete overview

💡 Tips

  1. Be responsive: Monitor the PR for review comments
  2. Be patient: Reviews may take time
  3. Be helpful: Answer questions from reviewers
  4. Be thorough: Provide any additional information requested

🎯 What Happens Next

  1. Automated checks may run (CI/CD)
  2. Reviewers will examine your changes
  3. Discussion may occur in PR comments
  4. Approval from maintainers
  5. Merge into the main repository

🆘 Need Help?

If you encounter issues:

  1. Check that your fork is up to date with upstream
  2. Ensure all commits are pushed: git push origin master
  3. Verify the PR description is complete
  4. Check that issues #271, #272, #273 exist in the upstream repo

📝 PR Template

If the repository has a PR template, it will auto-populate. You can replace it with the content from PR_DESCRIPTION.md or merge both.

Ready to create the PR? Follow Option 1 above! 🚀