Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
147 lines (98 loc) · 4.46 KB

CONTRIBUTING.md

File metadata and controls

147 lines (98 loc) · 4.46 KB

Contributing

Thank you for your interest in contributing!

The following is a set of guidelines for contributing to our project on Github. These are mostly guidelines, not rules.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to project moderators.

Development Setup

  1. Fork and clone the repository
  2. Create a virtual environment:
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  1. Install development dependencies:
pip install -e ".[testing]"
  1. Install pre-commit hooks:
pip install pre-commit
pre-commit install

Code Style

We use several tools to maintain code quality:

  • Ruff: For code formatting and linting
  • Pre-commit hooks: To automate style checks
  • Type hints: Required for all function parameters and return values

The project's code style is automatically enforced by pre-commit hooks. You can manually run the checks:

pre-commit run --all-files

Pull Requests

Please follow these guidelines when submitting pull requests (PRs):

  • PRs should be manageable in size to make it easy for us to validate and integrate
  • Each PR should be contained to a single fix or a single feature
  • Describe the motivation for the PR
  • Describe a methodology to test and validate, if appropriate

Please ensure that the code in your PR follows a style similar to that of the project. If you find a material discrepancy between the style followed by the project and a de facto standard style given the project language and framework, please let us know so we can amend and make our code more maintainable.

Testing

We use pytest for testing. Run the test suite:

# Run all tests
tox

# Run specific test environments
tox -e default
tox -e docs

Asking Questions

Prior to asking questions, please review:

  • Closed issues
  • Wiki pages
  • SDK documentation

If your question isn't answered in these resources, please file an issue! This helps us improve our documentation.

Reporting Bugs

If you encounter an issue, please let us know! We kindly ask that you supply the following information with your bug report when you file an issue. Feel free to copy/paste from the below and use as a template.

--- Bug Report ---

Operating system and version: Windows 10 Framework and runtime: .NET Core 2.0 Issue encountered: The widget shifted left Expected behavior: The widget should have shifted right Steps to reproduce: Instantiate the widget and call .ShiftRight()

Sample code demonstrating the problem:

from litegraph_sdk import configure

configure(
    endpoint="https://api.litegraph.com",
    graph_guid="your-graph-guid",
    timeout=30,  # 30 seconds
    retries=5    # 5 retry attempts
)
# Add code that demonstrates the issue

Exception details: [insert exception output here] Stack trace: [if appropriate]

--- End ---

Suggesting Enhancements

Should there be a way that you feel we could improve upon this project, please feel free to file an issue and use the template below to provide the necessary details to support the request.

Some basic guidelines for suggesting enhancements:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps including copy/pasteable snippets where possible
  • Describe the current behavior and the behavior you would like to see
  • Describe the usefulness of the enhancement to yourself and potentially to others

--- Enhancement Request ---

Enhancement request title: Widgets should have a color attribute Use case: I want to specify what color a widget is Current behavior: Widgets don't have a color Requested behavior: Allow me to specify a widget's color Recommended implementation: Add a Color attribute to the Widget class Usefulness of the enhancement: All widgets have color, and everyone has to build their own implementation to set this

--- End ---

Documentation

If you're updating documentation:

  1. Make changes to the relevant files in docs/
  2. Build documentation locally to verify changes:
tox -e docs
  1. Preview the built documentation in docs/_build/html/