Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
141 lines (106 loc) · 3.99 KB

CONTRIBUTING.md

File metadata and controls

141 lines (106 loc) · 3.99 KB
Raw

Contributing to Python ActiveRecord

First off, thank you for considering contributing to rhosocial-activerecord! It's people like you that make it such a great tool.

Where to get Help or Report an Issue

Issue Guidelines

If you find a bug or have a feature request, please create an issue:

  1. Go to GitHub Issues
  2. Create a new issue using the appropriate template
  3. Include the following information:
    • For bugs:
      • A clear description of what happened and what you expected to happen
      • Steps to reproduce the issue
      • Python version
      • Python ActiveRecord version
      • Database type and version
      • Any relevant code snippets or error messages
    • For feature requests:
      • A clear description of the feature
      • Use cases that demonstrate why this feature would be valuable
      • Any implementation ideas you have

Contributing Code

  1. Fork the repository
  2. Clone your fork: 
    git clone https://github.com/YOUR-USERNAME/python-activerecord.git
  3. Create a new branch: 
    git checkout -b feature/your-feature-name
  4. Make your changes and write tests if applicable
  5. Run the test suite: 
    python -m pytest
  6. Commit your changes: 
    git commit -m "Add some feature"
  7. Push to your fork: 
    git push origin feature/your-feature-name
  8. Create a Pull Request from your fork to our main branch

Development Setup

  1. Create a virtual environment: 
    python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  2. Install development dependencies: 
    pip install -r requirements-dev.txt

Code Style

  • Follow PEP 8 guidelines
  • Use meaningful variable and function names
  • Write docstrings for functions and classes
  • Include type hints where appropriate
  • Keep functions focused and concise

Testing

  • Write tests for any new functionality
  • Ensure all existing tests pass
  • Use pytest for testing
  • Aim for good test coverage

Documentation

If you're adding new features or changing existing ones:

  1. Update the docstrings
  2. Update the README.md if needed
  3. Add or update wiki pages for significant changes

Share Your Ideas

Have ideas for improvements? You can:

  1. Create an issue with the "enhancement" label
  2. Start a discussion in the GitHub Discussions section
  3. Share your thoughts in our community channels

Support the Project

If you find rhosocial-activerecord useful, you can:

  • Star the repository
  • Share it with others
  • Contribute code or documentation
  • Report bugs and provide feedback

Donations

We deeply appreciate any financial support that helps us maintain and improve rhosocial-activerecord. Your donations directly contribute to:

  • Maintaining the project
  • Developing new features
  • Improving documentation
  • Supporting community engagement

Donation Channels

You can support us through the following channels:

  1. GitHub Sponsors (Preferred)

  2. Open Collective

    • Support us on Open Collective
    • Transparent fund management
    • Available for both individuals and organizations

All donors will be acknowledged in our SPONSORS.md file (unless you prefer to remain anonymous).

Questions?

If you have any questions about contributing, feel free to:

  1. Check our documentation
  2. Open an issue
  3. Start a discussion

Thank you for contributing to Python ActiveRecord!