community-scripts/ProxmoxVED
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
ProxmoxVED/docs/contribution/README.md
CanbiZ 3860b7a9fa Restructure and expand contribution documentation 
Moved contribution-related docs to docs/contribution/, added new guides and templates for contributors, and updated references in docs/README.md to point to the new locations. This improves organization and provides clearer onboarding and standards for new contributors.
2025-12-01 12:35:16 +01:00

8.3 KiB
Raw Blame History

🤝 Contributing to ProxmoxVED

Complete guide to contributing to the ProxmoxVED project - from your first fork to submitting your pull request.

📋 Table of Contents

🚀 Quick Start

60 Seconds to Contributing

# 1. Fork on GitHub
# Visit: https://github.com/community-scripts/ProxmoxVED → Fork (top right)

# 2. Clone your fork
git clone https://github.com/YOUR_USERNAME/ProxmoxVED.git
cd ProxmoxVED

# 3. Auto-configure your fork
bash docs/contribution/setup-fork.sh

# 4. Create a feature branch
git checkout -b feature/my-awesome-app

# 5. Read the guides
cat docs/README.md              # Documentation overview
cat docs/ct/DETAILED_GUIDE.md   # For container scripts
cat docs/install/DETAILED_GUIDE.md  # For install scripts

# 6. Create your contribution
cp ct/example.sh ct/myapp.sh
cp install/example-install.sh install/myapp-install.sh
# ... edit files ...

# 7. Test and commit
bash ct/myapp.sh
git add ct/myapp.sh install/myapp-install.sh
git commit -m "feat: add MyApp"
git push origin feature/my-awesome-app

# 8. Create Pull Request on GitHub

🍴 Setting Up Your Fork

Automatic Setup (Recommended)

When you clone your fork, run the setup script to automatically configure everything:

bash docs/contribution/setup-fork.sh

This will:

  • Auto-detect your GitHub username
  • Update all documentation links to point to your fork
  • Create .git-setup-info with recommended git workflows

See: FORK_SETUP.md for detailed instructions

Manual Setup

If the script doesn't work, manually configure:

# Set git user
git config user.name "Your Name"
git config user.email "your.email@example.com"

# Add upstream remote for syncing
git remote add upstream https://github.com/community-scripts/ProxmoxVED.git

# Verify remotes
git remote -v

📖 Coding Standards

All scripts and configurations must follow our coding standards to ensure consistency and quality.

Available Guides

  • CONTRIBUTING.md - Essential coding standards and best practices
  • CODE_AUDIT.md - Code review checklist and audit procedures
  • Container Scripts - /ct/ templates and guidelines
  • Install Scripts - /install/ templates and guidelines
  • JSON Configurations - /json/ structure and format

Quick Checklist

  • ✅ Use /ct/example.sh as template for container scripts
  • ✅ Use /install/example-install.sh as template for install scripts
  • ✅ Follow naming conventions: appname.sh and appname-install.sh
  • ✅ Include proper shebang: #!/usr/bin/env bash
  • ✅ Add copyright header with author
  • ✅ Handle errors properly with msg_error, msg_ok, etc.
  • ✅ Test before submitting PR
  • ✅ Update documentation if needed

🔍 Code Audit

Before submitting a pull request, ensure your code passes our audit:

See: CODE_AUDIT.md for complete audit checklist

Key points:

  • Code consistency with existing scripts
  • Proper error handling
  • Correct variable naming
  • Adequate comments and documentation
  • Security best practices

📚 Guides & Resources

Documentation

Community Guides

See USER_SUBMITTED_GUIDES.md for excellent community-written guides:

  • Home Assistant installation and configuration
  • Frigate setup on Proxmox
  • Docker and Portainer installation
  • Database setup and optimization
  • And many more!

Templates

Use these templates when creating new scripts:

# Container script
cp ct/example.sh ct/my-app.sh

# Installation script
cp install/example-install.sh install/my-app-install.sh

# JSON configuration (if needed)
cp json/example.json json/my-app.json

🔄 Git Workflow

Keep Your Fork Updated

# Fetch latest from upstream
git fetch upstream

# Rebase your work on latest main
git rebase upstream/main

# Push to your fork
git push -f origin main

Create Feature Branch

# Create and switch to new branch
git checkout -b feature/my-feature

# Make changes...
git add .
git commit -m "feat: description of changes"

# Push to your fork
git push origin feature/my-feature

# Create Pull Request on GitHub

Before Submitting PR

  1. Sync with upstream

    git fetch upstream
git rebase upstream/main

  2. Test your changes

    bash ct/my-app.sh
# Follow prompts and test the container

  3. Check code standards

    • Follows template structure
    • Proper error handling
    • Documentation updated (if needed)
    • No hardcoded values
    • Version tracking implemented

  4. Push final changes

    git push origin feature/my-feature

📋 Pull Request Checklist

Before opening a PR:

  • Code follows coding standards (see CONTRIBUTING.md)
  • All templates used correctly
  • Tested on Proxmox VE
  • Error handling implemented
  • Documentation updated (if applicable)
  • No merge conflicts
  • Synced with upstream/main
  • Clear PR title and description

❓ FAQ

How do I test my changes?

# For container scripts
bash ct/my-app.sh

# For install scripts (runs inside container)
# The ct script will call it automatically

# For advanced debugging
VERBOSE=yes bash ct/my-app.sh

What if my PR has conflicts?

# Sync with upstream
git fetch upstream
git rebase upstream/main

# Resolve conflicts in your editor
git add .
git rebase --continue
git push -f origin your-branch

How do I keep my fork updated?

See "Keep Your Fork Updated" section above, or run:

bash docs/contribution/setup-fork.sh

Where do I ask questions?

  • GitHub Issues: For bugs and feature requests
  • GitHub Discussions: For general questions
  • Discord: Community-scripts server

🎓 Learning Resources

For First-Time Contributors

  1. Read: docs/README.md - Documentation overview
  2. Read: docs/contribution/FORK_SETUP.md - Fork setup guide
  3. Choose your path:
  4. Study existing scripts in same category
  5. Create your contribution

For Experienced Developers

  1. Review CONTRIBUTING.md - Coding standards
  2. Review CODE_AUDIT.md - Audit checklist
  3. Check templates in /ct/ and /install/
  4. Submit PR with confidence

For Reviewers/Maintainers

  1. Use CODE_AUDIT.md as review guide
  2. Reference docs/TECHNICAL_REFERENCE.md for architecture
  3. Check docs/EXIT_CODES.md for error handling

🚀 Ready to Contribute?

  1. Fork the repository
  2. Clone your fork and setup with bash docs/contribution/setup-fork.sh
  3. Choose your contribution type (container, installation, tools, etc.)
  4. Read the appropriate detailed guide
  5. Create your feature branch
  6. Develop and test your changes
  7. Commit with clear messages
  8. Push to your fork
  9. Create Pull Request

📞 Contact & Support

Thank you for contributing to ProxmoxVED! 🙏

Your efforts help make Proxmox VE automation accessible to everyone. Happy coding! 🚀