Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (52 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

77 lines (52 loc) · 2 KB

Contributing to StreamTeX

Thank you for your interest in contributing to StreamTeX!

Ways to Contribute

As a Developer (Python)

  1. Fork the repository and create a feature branch
  2. Install dependencies: uv sync
  3. Make your changes following coding standards
  4. Run tests: uv run pytest tests/ -v
  5. Run linter: uv run ruff check streamtex/
  6. Submit a Pull Request

As a Content Creator (AI-Assisted)

You don't need to write Python code to contribute content:

  1. Install a Claude profile from streamtex-claude
  2. Create example projects using /stx-project:project-init
  3. Submit interesting projects as example repositories

As a Claude Profile Developer

Improve the AI-assisted experience:

  1. Add new commands, skills, or agents in streamtex-claude/profiles/
  2. Follow the manifest.toml structure for each profile
  3. Test commands against real projects before submitting

Development Setup

Prerequisites

  • Python >= 3.11
  • uv (package manager)

Install

git clone https://github.com/nicolasguelfi/streamtex
cd streamtex
uv sync

Test

uv run pytest tests/ -v

Lint

uv run ruff check streamtex/
uv run ruff check streamtex/ --fix  # auto-fix

Pull Request Guidelines

  • One feature or fix per PR
  • Include tests for new functionality
  • Run lint and tests before submitting
  • Reference the relevant issue number if applicable
  • Update CHANGELOG.md for user-facing changes
  • Update AI_GUIDE.md if your change affects AI workflows

Code of Conduct

This project follows the Contributor Covenant v2.1. Contact: nicolas.guelfi@laposte.net

Questions?

Open an issue or start a discussion.