Improve code quality with documentation, security fixes, and enhanced functionality

[keith-oak]

Summary

This PR improves code quality across the MicroBots framework with comprehensive documentation, security enhancements, and new functionality:

• Documentation: Added comprehensive CONTRIBUTING.md guide and expanded README with detailed examples
• Code Documentation: Added docstrings to all bot classes and core MicroBot implementation
• Security: Fixed security issue with shell=True in subprocess calls
• API Updates: Updated OpenAI integration to use modern chat.completions.create method
• Platform Support: Added platform-specific command handling in Tool class
• New Features: Added overlay filesystem support for read-only mounts in both environments
• Public API: Exported CustomBot and BrowsingBot for public use

Type of Change

• Bug fix (security issue with subprocess)
• New feature (platform-specific tools, overlay mounts)
• Documentation update
• Breaking change

Testing

• All changes maintain backward compatibility
• Existing tests should continue to pass
• Manual testing performed on documentation examples

Commits

1. Fix trailing whitespace in .gitignore comments
2. Add comprehensive contributing guide with development setup and PR process
3. Update README with detailed documentation, usage examples, and bot descriptions
4. Add CustomBot and BrowsingBot to public exports
5. Add comprehensive docstrings and improve system prompts in MicroBot base class
6. Add docstrings to bot implementations for improved documentation
7. Update OpenAI API to use chat.completions.create method
8. Add platform-specific command support to Tool class
9. Fix security issue with shell=True in subprocess calls
10. Add overlay filesystem support for read-only mounts in swe-rex environment

Checklist

• Code follows project style guidelines
• Documentation updated
• Commit messages are clear and descriptive

[keith-oak]

@shivashanmugam @0xba1a @KavyaSree2610 @DonalDuck004

Hi team! This PR focuses on improving code quality across the MicroBots framework with:

• Documentation: Added CONTRIBUTING.md and expanded README with detailed examples
• Security fix: Removed shell=True from subprocess calls in LocalDockerEnvironment
• API modernization: Updated OpenAI integration to use chat.completions.create
• New functionality: Platform-specific command support in Tool class and overlay filesystem for read-only mounts
• Code documentation: Comprehensive docstrings across all bot classes

Each change is in a separate, focused commit following the contributing guidelines. Would appreciate your review when you have a chance!

[0xba1a]

Thanks @keith-oak for your contribution. I appreciate it.
Can you please raise each commit into a separate PR? It will be easy to isolate regressions.

If you plan for a long-term contribution, I suggest you raise one PR at a time.