Skip to content

Installation instructions and contributing docs#367

Open
bprobert97 wants to merge 10 commits into
mainfrom
installation-instructions-and-contributing-docs
Open

Installation instructions and contributing docs#367
bprobert97 wants to merge 10 commits into
mainfrom
installation-instructions-and-contributing-docs

Conversation

@bprobert97

@bprobert97 bprobert97 commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

This PR adds documentation to support users wishing to contribute to and use labthings-fastapi.

  • A contributing.md file has been added, showing users where to seek support, report bugs, and how to contribute to the codebase.
  • The readme.md file has been updated with a note on Windows installation of labthings-fastapi and a link to the contributing.md file
  • The readthedocs documentation has been updated to add information about Python version compatibility and Windows installation, and a link to contributing.md

Note: the failure for test-with-unpinned-dependencies is not related to any code changes I have made and should be fixed in a separate PR.

@bprobert97 bprobert97 marked this pull request as draft June 19, 2026 15:00
@barecheck

barecheck Bot commented Jun 19, 2026

Copy link
Copy Markdown

Barecheck - Code coverage report

Total: 96.97%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

@bprobert97 bprobert97 marked this pull request as ready for review June 19, 2026 15:36
@bprobert97 bprobert97 requested a review from rwb27 June 19, 2026 15:37
bprobert97 added a commit that referenced this pull request Jun 19, 2026
Added MR #367 references to Windows installation and CONTRIBUTING.md instructions.
Comment thread CONTRIBUTING.md Outdated
Comment thread dev-requirements.txt
Comment on lines +2 to +5
# This file is autogenerated by pip-compile with Python 3.13
# by the following command:
#
# pip-compile --extra=dev --output-file=dev-requirements.txt pyproject.toml

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't the recommended way

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is auto-generated text. I use pip-compile instead of uv (because I don't have uv). This is okay to use (there is a section in contributing.md about this)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants