Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (55 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

78 lines (55 loc) · 2.03 KB

Contributing to Enhanced Theme Studio

Thank you for considering contributing to Enhanced Theme Studio! This document provides guidelines and steps for contributing.

Code of Conduct

Please be respectful and considerate of others when contributing or interacting with this project.

How Can I Contribute?

Reporting Bugs

  • Check if the bug has already been reported in the Issues
  • Use the bug report template when creating a new issue
  • Include detailed steps to reproduce the bug
  • Include screenshots if applicable
  • Describe what you expected to happen vs. what actually happened

Suggesting Features

  • Check if the feature has already been suggested in the Issues
  • Use the feature request template when creating a new issue
  • Explain why this feature would be useful to most users
  • Provide as much detail as possible about how the feature should work

Pull Requests

  1. Fork the repository
  2. Create a new branch for your feature (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests to ensure your changes don't break existing functionality
  5. Commit your changes with descriptive commit messages
  6. Push to your branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Development Setup

  1. Create a virtual environment:

    python -m venv venv

  2. Activate the virtual environment:

    # Windows
venv\Scripts\activate

# macOS/Linux
source venv/bin/activate

  3. Install dependencies:

    pip install -r requirements.txt

  4. Run the application:

    python enhanced_theme_generator.py

Style Guide

  • Follow PEP 8 guidelines for Python code
  • Use descriptive variable and function names
  • Include docstrings for classes and methods
  • Keep functions small and focused on a single task
  • Comment complex code sections

Testing

If you add new features, please include appropriate tests.

Documentation

If you add new features or change existing ones, please update the documentation accordingly.

Thank you for contributing!