Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
88 lines (64 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

88 lines (64 loc) · 2.68 KB
Raw

Contributing to ScreenRuler Pro

First off, thank you for considering contributing to ScreenRuler Pro! It's people like you that make ScreenRuler Pro such a great tool.

Code of Conduct

This project and everyone participating in it is governed by respect and professionalism. Please be kind and courteous.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the existing issues to avoid duplicates. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps to reproduce the problem
  • Provide specific examples
  • Describe the behavior you observed and what behavior you expected
  • Include screenshots if possible
  • Include your environment details (Windows version, Python version if applicable)

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • Use a clear and descriptive title
  • Provide a detailed description of the suggested enhancement
  • Explain why this enhancement would be useful
  • List any similar features in other applications

Pull Requests

  • Fill in the required template
  • Follow the Python style guide (PEP 8)
  • Include comments in your code where necessary
  • Update documentation if needed
  • Test your changes thoroughly

Development Setup

  1. Fork the repository
  2. Clone your fork: 
    git clone https://github.com/your-username/ScreenRuler-Pro.git
  3. Create a virtual environment: 
    python -m venv .venv
.venv\Scripts\activate
  4. Install dependencies: 
    pip install -r requirements.txt
  5. Create a branch for your changes: 
    git checkout -b feature/your-feature-name

Coding Standards

  • Follow PEP 8 style guide
  • Use meaningful variable and function names
  • Write docstrings for functions and classes
  • Keep functions focused and concise
  • Add comments for complex logic

Testing

Before submitting a pull request:

  1. Test the application thoroughly
  2. Verify all keyboard shortcuts work
  3. Test on different screen resolutions if possible
  4. Ensure no errors in console/terminal

Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests after the first line

Questions?

Feel free to open an issue with your question or contact the maintainer at dinuka90@yuhs.ac

Thank you for contributing! 🎉