Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Development

## Setup steps

Make sure the following tooling is installed:
- [uv](https://docs.astral.sh/uv/getting-started/installation/)

Install the project and dev dependencies via `uv sync --all-groups`.

Then set up the git hook scripts via `uv run pre-commit install`.

## Nox sessions

Run `nox -l` for a list of available nox sessions, or simply run `nox`
to run the ruff linter and the pytest suite for all supported Python versions.

## Releasing

Kotobuki uses [semantic versioning](https://semver.org/).

New releases are made from the main branch. Whenever making a new release,
check the following:
- CHANGELOG.md includes a summary of all changes since the last release.
- The package version stated in pyproject.toml reflects the release you want
to make.

Once you create the release on GitHub, the release will be automatically
published to PyPI via the `publish` GitHub action.
20 changes: 7 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,12 @@ uv run --with jupyter,psycopg2,kotobuki jupyter lab
## Usage
See [User documentation](https://github.com/thehyve/kotobuki/blob/main/docs/kotobuki.md)

## Development
## Contributing

### Setup steps
We welcome all contributions, including bug reports, fixes, documentation enhancements,
new ideas, and general improvements.

Make sure the following tooling is installed:
- [uv](https://docs.astral.sh/uv/getting-started/installation/)

Install the project and dev dependencies via `uv sync --all-groups`.

Then set up the git hook scripts via `uv run pre-commit install`.

### Nox sessions

Run `nox -l` for a list of available nox sessions, or simply run `nox`
to run the ruff linter and the pytest suite for all supported Python versions.
- We use the GitHub [issue tracker](https://github.com/thehyve/kotobuki/issues)
for all bugs/issues/enhancements.
- See the [contributing](https://github.com/thehyve/kotobuki/CONTRIBUTING.md) page
for instructions on kotobuki development.
Loading