Contributing

Contributions are welcome and greatly appreciated! Every bit helps, and credit will always be given.

Types of contributions

Report bugs

Report bugs here.

Please include

• your operating system and package version,

• any details about your local setup that might be helpful, and

• steps to reproduce the bug.

Fix bugs

Look through our issues. Anything tagged with bug and help wanted is open to whoever wants to implement it.

Implement features

Any issue tagged with enhancement and help wanted is open to whoever wants to implement it.

Write documentation

lazyscribe can always use more documentation. If you are writing docstrings, please make sure to run our QA tools before submitting a PR:

python -m pip install -e .[qa]
python -m ruff check .
python -m ruff format .
python -m mypy lazyscribe

If you’re writing sphinx documentation, make sure to build the docs locally and preview them before submitting a PR:

python -m pip install -e .[docs]
make docs
cd docs/
python -m http.server

Submit feedback

The best way to send feedback is by opening an issue. If you are proposing a feature,

• explain it in detail,

• keep the scope narrow, and

• remember that this project is volunteer-driven, contributions are welcome!

Get started

Ready to contribute? Here’s how you can set up:

1. Fork the repository on GitHub

2. Clone your fork:

   $ git clone https://github.com/<USERNAME>/lazyscribe.git
   

3. Add the upstream remote. This saves a reference to the main repository:

   $ git remote add upstream https://github.com/lazyscribe/lazyscribe.git
   

4. Install your local copy into a virtualenv. We recommend using mamba:

   $ mamba create -n lazyscribe python=3.12 -y
   $ conda activate lazyscribe
   $ python -m pip install -r requirements.txt -e .[dev]
   

5. Create a branch for local development:

   $ git checkout -b name-of-branch
   

6. When you’re done making changes, run the QA tooling and tests:

   $ python -m ruff check .
   $ python -m ruff format .
   $ python -m mypy lazyscribe
   $ python -m pytest tests --cov=lazyscribe --cov-report=term-missing
   

7. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "A detailed description"
   $ git push origin name-of-branch
   

8. Submit a pull request!