Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (45 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

64 lines (45 loc) · 1.54 KB

Contributing to WHManager

Thank you for your interest in contributing to WHManager! This document provides guidelines and instructions for contributing to the project.

Code of Conduct

Please be respectful and considerate of others when contributing to this project.

How to Contribute

  1. Fork the repository
  2. Create a new branch for your feature/fix
  3. Make your changes
  4. Submit a pull request

Development Setup

  1. Clone the repository:
git clone https://github.com/yourusername/WHManager.git
cd WHManager
  1. Install dependencies:
# Add any specific setup instructions here
  1. Run the development environment:
# Add any specific run instructions here

Project Structure

  • src/web/ - Web interface files
  • src/scripts/ - Installation and utility scripts
  • config/ - Configuration files
  • docs/ - Documentation
  • tests/ - Test files

Coding Standards

  • Follow the existing code style
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions focused and small
  • Update documentation when making changes

Testing

  • Write tests for new features
  • Ensure all tests pass before submitting PR
  • Include both unit and integration tests where appropriate

Pull Request Process

  1. Update the README.md with details of changes if needed
  2. Update the documentation if you're changing functionality
  3. The PR will be merged once you have the sign-off of at least one maintainer

Questions?

Feel free to open an issue if you have any questions about contributing.