Skip to content

Contributing

Contributions are welcome. seoslug is pure Python with minimal dependencies.

Setup

Clone the repository.

git clone https://github.com/emiliano-go/seoslug.git
cd seoslug

Install in editable mode.

pip install -e ".[test]"

Running tests

python -m pytest -q

All tests must pass before you submit changes.

Code style

Follow PEP 8. Keep functions small and focused. Use descriptive names.

Adding features

Add tests for new features. Update the documentation for any user facing changes. Keep the public API minimal.

Submitting changes

Open a pull request. Use a short description of what changed and why. Maintainers will review within one week.

Documentation

Documentation uses Markdown. Follow the writing guide for tone and style. Update or add pages in the docs directory.