Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
148 lines (106 loc) · 4.95 KB

CONTRIBUTING.md

File metadata and controls

148 lines (106 loc) · 4.95 KB

Contributing to IBind

Thank you for your interest in contributing to IBind! This document provides guidelines and best practices for contributing to the project.

Table of Contents

Getting Started

Before you start contributing, please:

  1. Fork the repository
  2. Create a new branch for your feature/fix
  3. Set up your development environment

Development Setup

  1. Clone your fork:

    git clone https://github.com/YOUR_USERNAME/ibind.git
cd ibind

  2. Create and activate a virtual environment:

    python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

  3. Install development dependencies:

    pip install -r requirements-dev.txt

  4. Install optional oauth dependency:

    pip install -r requirements-oauth.txt

Contribution Workflow

Feature Requests and Enhancements

  1. For new features or significant changes:

    • Create an issue using the "Enhancement" template
    • Discuss the feature in the issue before implementing
    • Once there's agreement, create a draft PR
    • Mark the PR as "Ready for Review" when implementation is complete

  2. For small improvements or bug fixes:

    • Create a PR directly
    • Include a clear description of the changes
    • Link to any related issues

Pull Request Guidelines

  1. PR Size:

    • Keep PRs focused and manageable (ideally under 500 lines)
    • Split large changes into multiple PRs
    • Each PR should address one specific feature or fix

  2. PR Content:

    • Use clear, descriptive commit messages
    • Include tests for new features
    • Update documentation as needed
    • Add comments for complex logic
    • Ensure all tests pass

  3. PR Process:

    • Create a draft PR for work in progress
    • Request review when ready
    • Address review comments promptly
    • Keep the PR up to date with the main branch

Issue Guidelines

  1. Bug Reports:

    • Use the "Bug Report" template
    • Include steps to reproduce
    • Provide environment details
    • Share error messages and logs

  2. Enhancement Requests:

    • Use the "Enhancement" template
    • Explain the problem you're trying to solve
    • Describe your proposed solution
    • Include use cases and benefits

Low-effort Contributions

We understand that some users rely on AI tools to assist with coding. That's fine - we do too - but please review and edit any AI generated code before submitting it in an issue or pull request. Submissions that include large, unedited 'code dumps' or show little effort on the side of the author, such as ignoring method signatures, documentation, or clear stack traces may be considered low-effort.

When reporting bugs or proposing changes:

  • Focus on the minimal relevant code, not full scripts.
  • Make sure you've read the documentation and attempted to respond to the error messages.
  • Use the issue templates.

Issues or PRs that don't meet these standards may be closed with a note encouraging revision. If you update the content to reflect a clearer and more focused report, we're happy to re-engage.

Closing message template:

Thanks for the contribution, however it appears to lack sufficient effort (eg. not consulting the documentation, stack trace, or method signatures) or contains unredacted AI generated code. To keep the issue/PR trackers focused and maintainable, we're closing this for now. Please review our contributing policies in the [CONTRIBUTING.md](https://github.com/Voyz/ibind/blob/master/CONTRIBUTING.md) file.

If you revise the contribution - focusing on the minimal relevant code, confirming it aligns with the library's API and demonstrating your attempt to tackle it - we'll be happy to take another look.

Code Style

  • You can run the format command with make format in the Makefile.
  • The formatting rules are defined in pyproject.toml
  • Follow PEP 8 guidelines
  • Write docstrings for all public functions and classes
  • Keep functions focused and single-purpose
  • Use meaningful variable and function names

Documentation

  • Update relevant documentation for any changes
  • Include docstrings for new functions and classes
  • Update examples if applicable
  • Keep the README.md up to date

Release Process

  • IBind is distributed through Pypi.
  • Semantic Versioning 2.0.0 is used.
  • Minor changes are published directly as new releases. Otherwise one or many release candidate versions are published (eg. rc1, rc2, etc.) and made available for a period of time in order to test the new functionalities.

Questions?

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

  1. Open an issue
  2. Join discussions in existing issues
  3. Contact the maintainers

Thank you for contributing to IBind!