Contributing to Prompt Decorators¶

Thank you for your interest in contributing to the Prompt Decorators project! This document provides guidelines and instructions for contributing.

Code of Conduct¶

Please read and follow our Code of Conduct.

How to Contribute¶

There are many ways to contribute to the Prompt Decorators project:

Report bugs: If you find a bug, please create an issue on our GitHub repository.
Suggest features: If you have an idea for a new feature, please create an issue on our GitHub repository.
Improve documentation: Help us improve our documentation by fixing typos, adding examples, or clarifying explanations.
Write code: Contribute bug fixes, new features, or improvements to existing features.

Development Setup¶

Prerequisites¶

Python 3.11 or higher
Poetry (dependency management)
git

Setting Up the Development Environment¶

Fork the repository on GitHub.

Clone your fork locally:

git clone https://github.com/yourusername/prompt-decorators.git
cd prompt-decorators

Install Poetry if you don't have it already:

curl -sSL https://install.python-poetry.org | python3 -

Install the package with all dependencies:
```
poetry install
```

Running Tests¶

We use pytest for testing. To run the tests:

poetry run pytest

To run tests with coverage:

poetry run pytest --cov=prompt_decorators

Code Style¶

We follow the PEP 8 style guide for Python code. We use the following tools to enforce code style:

black: For code formatting
isort: For import sorting
ruff: For linting

To format your code:

poetry run black prompt_decorators tests
poetry run isort prompt_decorators tests

To check your code for style issues:

poetry run ruff check prompt_decorators tests

Type Checking¶

We use mypy for type checking. To run type checking:

poetry run mypy prompt_decorators

Docstring Standards¶

We follow Google-style docstrings for all Python code. Please refer to our Docstring Standards for detailed guidelines.

To check if your docstrings follow our standards:

./standardize_docstrings.py path/to/your/file.py --report

To automatically fix common docstring issues:

./fix_docstrings.py path/to/your/file.py

We've also set up pre-commit hooks to check docstrings before commits:

# Install pre-commit hooks
poetry run pre-commit install

Pre-commit Hooks¶

We use pre-commit hooks to check code style, types, and docstrings before commits. To install the pre-commit hooks:

poetry run pre-commit install

Pull Request Process¶

Create a new branch for your feature or bug fix:
```
git checkout -b feature/your-feature-name
```
Make your changes and commit them with a descriptive commit message.

Push your branch to your fork:

git push origin feature/your-feature-name

Create a pull request from your branch to the main repository.
Ensure that all tests pass and there are no style issues.
Update the documentation if necessary.
Wait for a maintainer to review your pull request.

Adding a New Decorator¶

To add a new decorator to the registry:

Create a new JSON file in the appropriate category directory under registry/.
Define the decorator's parameters, constraints, and metadata.

Run the code generation script:

poetry run python generate_decorators.py

Add tests for your new decorator.
Update the documentation if necessary.

Documentation¶

We use MkDocs with the Material theme for documentation. To build the documentation locally:

# Generate API and decorator documentation
cd docs
python generate_docs.py

# Serve documentation locally
poetry run mkdocs serve

This will start a local server at http://localhost:8000 where you can preview the documentation.

Important: Always use docs/generate_docs.py to regenerate the API reference and decorator documentation before building or serving with MkDocs. Any other documentation generators found in the codebase are deprecated.

License¶

By contributing to the Prompt Decorators project, you agree that your contributions will be licensed under the project's MIT License.