Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
171 lines (125 loc) · 4.15 KB

CONTRIBUTING.md

File metadata and controls

171 lines (125 loc) · 4.15 KB

Contributing to PyNote

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

🎯 Getting Started

  1. Fork the repository and clone it locally
  2. Create a virtual environment: 
    python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -r requirements.txt
  3. Find an issue labeled good first issue or check the difficulty labels
  4. Create a branch following our naming convention
  5. Make your changes and test them
  6. Submit a pull request

📝 Branch Naming

Use descriptive branch names:

  • feature/<short-desc> - for new features
  • bug/<short-desc> - for bug fixes
  • docs/<short-desc> - for documentation updates

Examples:

  • feature/add-toolbar-icons
  • bug/fix-save-dialog
  • docs/update-readme

💬 Commit Messages

Use short, imperative commit messages:

  • ✅ fix: update save dialog
  • ✅ feat: add dark theme toggle
  • ✅ docs: update contributing guide
  • ❌ Fixed some stuff
  • ❌ updates

Format: <type>: <description>

Types: fix, feat, docs, style, refactor, test, chore

🔍 Issue Labels

  • good first issue - Perfect for beginners
  • easy - Beginner-friendly tasks (1-2 hours)
  • medium - Intermediate tasks (3-5 hours)
  • hard - Advanced tasks (6-10 hours)
  • bug - Something isn't working
  • enhancement - New feature or improvement
  • documentation - Documentation improvements
  • help wanted - Extra attention needed
  • design - UI/UX related

📋 Pull Request Process

  1. Reference an issue - All PRs should reference an issue number (e.g., Fixes #123)
  2. Keep PRs focused - One logical change per PR
  3. Include screenshots - For UI changes, include before/after screenshots
  4. Test your changes - Run the app and verify it works
  5. Update documentation - If adding features, update relevant docs
  6. Label your PR - Add appropriate labels when creating the PR

PR Template

When creating a PR, include:

## Description
Brief description of changes

## Related Issue
Closes #123

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update
- [ ] Other (please describe)

## Testing
Steps to test:
1. ...
2. ...

## Screenshots (if applicable)
[Add screenshots here]

## Checklist
- [ ] Code follows project style guidelines
- [ ] Self-review completed
- [ ] Comments added for complex code
- [ ] Documentation updated
- [ ] No new warnings generated
- [ ] Tests pass (if applicable)

🧪 Testing

Before submitting a PR:

  1. Run the application: 
    python -m src.pynote.main
  2. Test your changes manually
  3. Run tests (if applicable): 
    pytest tests/

📐 Code Style

  • Follow PEP 8 for Python code
  • Use meaningful variable names
  • Add comments for complex logic
  • Keep functions focused and small
  • Use type hints where appropriate

🎨 UI Guidelines

  • Follow existing UI patterns
  • Ensure dark/light theme compatibility
  • Test on different screen sizes if applicable
  • Keep the interface clean and intuitive

🐛 Reporting Bugs

Use the bug report template and include:

  • Clear description of the bug
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots (if applicable)
  • Environment details (OS, Python version)

💡 Suggesting Features

Use the feature request template and include:

  • Clear description of the feature
  • Use case / problem it solves
  • Proposed solution
  • Mockups or examples (if applicable)

📊 Acceptance Criteria

Each issue includes acceptance criteria. Make sure your PR satisfies all criteria before submitting.

Example:

  • ✅ Feature works as described
  • ✅ Code follows style guidelines
  • ✅ No regressions introduced
  • ✅ Documentation updated

❓ Questions?

  • Open a discussion in the repository
  • Check existing issues for similar questions
  • Reach out to maintainers

🙏 Thank You!

Your contributions make PyNote better for everyone. We appreciate your time and effort!

Happy Contributing! 🚀