Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs+feat: improve contributing guide and add clean_examples utility #4520

Closed

Conversation

devin-ai-integration[bot]
Copy link

Improve Contributing Guide and Add Development Utility

This PR improves the CONTRIBUTING.md guide with clearer instructions and adds a new utility script to help developers maintain a clean development environment.

Changes

  • Add more detailed instructions for development workflow
  • Clarify type stub generation process and requirements
  • Add comprehensive troubleshooting section
  • Add clean_examples.py utility script for managing example apps
  • Improve formatting and organization of the guide

Testing

  • ✅ Verified all documented processes work as described
  • ✅ Tested clean_examples.py script functionality
  • ✅ All pre-commit checks pass
  • ✅ No changes to generated .pyi files needed

Additional Notes

  • The clean_examples.py script helps developers maintain a clean environment when switching between different example apps
  • Added clarification about development server behavior and frontend-only mode
  • Improved organization of pre-commit and testing instructions

Link to Devin run: https://app.devin.ai/sessions/66907725d04547a5ace91cdf983e69a2

- Add more detailed instructions for development workflow
- Clarify type stub generation process
- Add troubleshooting section
- Add clean_examples.py utility script
- Improve formatting and organization

Co-Authored-By: Alek Petuskey <alek@reflex.dev>
Copy link
Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR
  • Look at CI failures and help fix them

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Add "(aside)" to your comment to have me ignore it.

@Alek99 Alek99 closed this Dec 13, 2024
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.

1 participant