Best Practices - jvPalma/dotrun GitHub Wiki
Best Practices
This page has been restructured for better organization!
The content from this page has been split into focused, topic-specific guides based on your role and needs:
🔗 New Structure
Script Development
- Script Development Best Practices - Essential practices for creating maintainable, secure scripts
- Naming conventions and organization
- Script structure and documentation
- Error handling and security
- Platform compatibility
Team Collaboration
- Team Collaboration Best Practices - Effective team workflows with DotRun
- Collection management strategy
- Team adoption and onboarding
- Code review processes
- Communication guidelines
Organization & Maintenance
- Collection Organization Guide - Structuring scripts and collections
- Performance Optimization - Making scripts and workflows faster
- Security Patterns - Security-focused development practices
Quick Migration Guide
Looking for specific content? Here's where to find it now:
| Old Section | New Location |
|---|---|
| Script naming conventions | Script Development Best Practices |
| Error handling patterns | Script Development Best Practices |
| Security considerations | Script Development Best Practices |
| Team adoption strategy | Team Collaboration Best Practices |
| Collection management | Team Collaboration Best Practices |
| Code review processes | Team Collaboration Best Practices |
| Performance optimization | Performance Optimization |
| Platform compatibility | Script Development Best Practices |
Benefits of the New Structure
🎯 Focused Content: Each page covers a single topic in depth 📚 Role-Based: Find information based on your role (developer, team lead, etc.) 🔍 Better Navigation: Easier to find specific information 📖 Comprehensive: More detailed examples and explanations
This reorganization makes the documentation more accessible and actionable. Each new page provides comprehensive guidance for its specific area.