Skip to content

Latest commit

 

History

History
156 lines (104 loc) · 4.77 KB

CONTRIBUTING.md

File metadata and controls

156 lines (104 loc) · 4.77 KB

Contributor Guide

Thank you for your interest in improving this project. This project is open-source under the MIT license and welcomes contributions in the form of bug reports, feature requests, and pull requests.

Here is a list of important resources for contributors:

How to report a bug

Report bugs on the Issue Tracker.

When filing an issue, make sure to answer these questions:

  • Which operating system and Python version are you using?
  • Which version of this project are you using?
  • What did you do?
  • What did you expect to see?
  • What did you see instead?

The best way to get your bug fixed is to provide a test case, and/or steps to reproduce the issue.

How to request a feature

Request features on the Issue Tracker.

How to set up your development environment

You need the following tools:

Install uv

Instructions: https://docs.astral.sh/uv/getting-started/installation/

No specific Python version needs to be installed, uv handles this automatically.

Install Nox

uv tool install nox

Install nbstripout

This tool is necessary when working with the Notebooks in the demo directory.

uv tool install nbstripout

Install the pre-commit hooks

nox --session=pre-commit -- install

Install the package with development requirements

uv sync

How to test the project

Run the full test suite:

nox

After running the suite for the first time, we recommend reusing the virtual environment for speed of execution. This can be done using the -r flag e.g.

nox -r

List the available Nox sessions:

nox --list-sessions

You can also run a specific Nox session. For example, invoke the unit test suite like this:

nox --session=tests

Unit tests are located in the tests directory, and are written using the pytest testing framework.

Recommended editor tooling

For a comfortable development experience we recommend the following tools/extensions/language servers as a minimum:

How to incorporate breaking model changes

We keep the version of ssb-datadoc-model pinned since almost all changes there are breaking changes and we don't want this package to be bumped accidentally. When upgrading the version of this package there are a number of things to consider:

  1. Bump the package version
  2. Run the tests and see what fails
  3. Handle upgrading older document versions by adding code in: src/dapla_metadata/datasets/compatibility
    1. Write a handler function to make the necessary changes
    2. Register the handler function as a BackwardsCompatibleVersion instance
    3. Add a metadata document under tests/datasets/resources/existing_metadata_file/compatibility/v<YOUR_VERSION> for use in testing.
  4. Fix any source or test code which refers to outdated fields
  5. Upgrade all the documents in the tests/datasets/resources/existing_metadata_file directory (NOT those in the compatibility directory) to the latest version. This can be done using the script e.g. uv run python bin/upgrade_metadata_file.py --path tests/datasets/resources/existing_metadata_file/person_data_v1__DOC.json

How to submit changes

Open a pull request to submit changes to this project.

Your pull request needs to meet the following guidelines for acceptance:

  • The Nox test suite must pass without errors and warnings.
  • Include unit tests. This project maintains 100% code coverage.
  • If your changes add functionality, update the documentation accordingly.

Feel free to submit early, though—we can always iterate on this.

To run linting and code formatting checks before committing your change, you can install pre-commit as a Git hook by running the following command:

nox --session=pre-commit -- install

It is recommended to open an issue before starting work on anything. This will allow a chance to talk it over with the owners and validate your approach.