Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (59 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

73 lines (59 loc) · 1.69 KB
Raw

Contributing to Plex Docker Setup

Thank you for your interest in contributing! This document outlines the process for contributing to this project.

Code of Conduct

  • Be respectful of others
  • Keep discussions professional
  • Focus on improving the project

How to Contribute

1. Fork and Clone

# Fork via GitHub interface, then:
git clone https://github.com/YOUR_USERNAME/plex-docker-setup.git
cd plex-docker-setup

2. Create a Branch

git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-fix-name

3. Development Guidelines

  • Follow existing code style
  • Add comments to complex logic
  • Update documentation as needed
  • Test your changes thoroughly

4. Testing

  • Test all scripts affected by your changes
  • Verify Docker container functionality
  • Check for proper error handling
  • Test on both new and existing setups

5. Commit Messages

  • Use clear, descriptive commit messages
  • Start with a verb (Add, Fix, Update, etc.)
  • Reference issues if applicable

Example:

git commit -m "Add automatic email retry on failure"
# or
git commit -m "Fix storage monitoring script path. Fixes #123"

6. Submit Pull Request

  1. Push your changes
  2. Create PR via GitHub
  3. Describe your changes
  4. Link related issues

Types of Contributions

  • Bug fixes
  • Feature additions
  • Documentation improvements
  • Script optimizations
  • Security enhancements

Attribution

All contributions will be under the MIT License with Attribution requirements. You'll be added to the contributors list in the README.

Questions?

Open an issue for:

  • Feature discussions
  • Bug reports
  • Documentation clarification
  • General questions

Thank you for contributing!