Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
140 lines (111 loc) · 3.82 KB

CONTRIBUTING.md

File metadata and controls

140 lines (111 loc) · 3.82 KB

🤝 Contributing to PowerContainers

Thank you for your interest in contributing to PowerContainers! 🎉

📋 How to Contribute

🐛 Reporting Bugs

  1. Check if the bug has already been reported in Issues
  2. If not, create a new issue with:
    • Clear description of the problem
    • Steps to reproduce
    • Expected vs actual behavior
    • Your environment (OS, Docker version, VS Code version)

✨ Suggesting Enhancements

  1. Check existing Issues and Pull Requests
  2. Create an issue describing:
    • The enhancement you'd like to see
    • Why it would be useful
    • How it should work

🔧 Adding New Containers

We welcome contributions of new development containers! Follow these guidelines:

  1. Create a new folder following the naming convention: language-framework/

  2. Include required files:

    your-container/
├── .devcontainer/
│   ├── devcontainer.json
│   └── Dockerfile
├── .vscode/
│   ├── settings.json
│   └── launch.json
└── README.md

  3. Dockerfile requirements:

    • MUST be multi-stage
    • Include a development target
    • Include a production target
    • Add comments for each stage
    • Follow existing patterns

  4. README requirements:

    • Use English language
    • Include emojis and colors
    • Follow the template structure:
      • Overview with checkmarks
      • Quick Start
      • Included Tools
      • VS Code Extensions
      • Customization section
      • Usage Examples
      • Resources

  5. devcontainer.json requirements:

    • Set appropriate extensions
    • Configure proper settings
    • Include postCreateCommand
    • Set correct user

📝 Pull Request Process

  1. Fork the repository
  2. Create a new branch: git checkout -b feature/your-feature-name
  3. Make your changes
  4. Test your container: 
    cd your-container
code .
# Reopen in Container and verify everything works
  5. Commit your changes: git commit -am 'Add some feature'
  6. Push to your fork: git push origin feature/your-feature-name
  7. Create a Pull Request

✅ Checklist Before Submitting PR

  • Multi-stage Dockerfile implemented
  • README.md with emojis and proper formatting
  • All required VS Code configuration files included
  • Container builds successfully
  • Container runs without errors
  • Documentation is clear and complete
  • No sensitive information in files

🎨 Style Guidelines

Dockerfile:

  • Use multi-stage builds
  • Name stages descriptively
  • Add comments for complex operations
  • Clean up apt cache: && rm -rf /var/lib/apt/lists/*
  • Use specific versions when possible

Documentation:

  • Use emojis consistently
  • Format code blocks with language hints
  • Include practical examples
  • Keep it concise but complete

JSON files:

  • Use 2-space indentation
  • Keep arrays and objects formatted clearly

🌟 Container Ideas

Looking for ideas? Here are some containers we'd love to see:

  • 🦀 Rust
  • 🐹 Go
  • ☕ Java (Spring Boot, Quarkus)
  • 💎 Ruby (Rails)
  • 🐘 PHP (Laravel)
  • 🦕 Deno
  • 🔷 Kotlin
  • 🎯 Dart (without Flutter)
  • 🌊 Elixir (Phoenix)
  • 📊 R
  • 🎮 Game Development (Unity, Godot)
  • 🔗 Blockchain Development
  • 🤖 Machine Learning (TensorFlow, PyTorch)

📚 Resources

💬 Questions?

Feel free to open an issue with your question or reach out to the maintainers.

Thank you for contributing! 🙏