Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (54 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

82 lines (54 loc) · 1.75 KB

Contributing to SassyShell

We appreciate your interest in contributing to SassyShell! Here's how you can help.

Getting Started

  1. Fork the repository and clone it locally
  2. Install uv if you haven't already: https://docs.astral.sh/uv/
  3. If you have sassyshell installed via pipx, uninstall it first to avoid conflicts:
pipx uninstall sassyshell
  1. Set up the development environment:
uv sync

This command installs all dependencies and the project itself in editable mode. The sassyshell and sassysh commands will be available in your shell.

  1. Activate your virtual environment:
source .venv/bin/activate
  1. After making code changes, rebuild the package:
uv build

Or if you prefer using pip directly:

pip install -e .
  1. After making code changes, rebuild the package:
uv build

Or if you prefer using pip directly:

pip install -e .
  1. Create a new branch for your changes:
git checkout -b feature/your-feature-name

Development

  • All dependencies are managed by uv. If you add new dependencies, update them in pyproject.toml and run uv sync again.
  • The project is installed in editable mode, so changes to the source code take effect immediately.
  • Make your changes in the src/sassyshell/ directory
  • Test your changes before submitting a pull request

Submitting Changes

  1. Commit your changes with clear, descriptive messages
  2. Push to your fork
  3. Open a pull request with a description of your changes

Code Standards

  • Keep code simple and readable
  • Add tests for new features when possible
  • Follow the existing code style

Questions?

Open an issue if you have questions or need clarification.

Thank you for contributing!