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
79 changes: 79 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
name: Bug report
description: Report a reproducible problem with SeaSenseLib
title: "[Bug]: "
body:
- type: markdown
attributes:
value: |
Thank you for helping improve SeaSenseLib. Please provide a small,
reproducible example. Remove sensitive information from logs and data.

- type: textarea
id: description
attributes:
label: Problem
description: What happened, and what did you expect to happen?
validations:
required: true

- type: textarea
id: reproduce
attributes:
label: Reproducible example
description: Include the smallest code example and input description that reproduce the problem.
render: python
validations:
required: true

- type: input
id: seasenselib_version
attributes:
label: SeaSenseLib version
placeholder: "For example: 0.6.1"
validations:
required: true

- type: input
id: python_version
attributes:
label: Python version
placeholder: "For example: 3.12.4"
validations:
required: true

- type: input
id: operating_system
attributes:
label: Operating system
placeholder: "For example: Ubuntu 24.04, macOS 15, or Windows 11"
validations:
required: true

- type: input
id: data_source
attributes:
label: Instrument or data format
description: If relevant, identify the instrument, file format, and firmware or software version.

- type: textarea
id: traceback
attributes:
label: Error output
description: Paste the complete traceback or relevant log output, if available.
render: shell

- type: textarea
id: context
attributes:
label: Additional context
description: Add anything else that may help diagnose the problem.

- type: checkboxes
id: checks
attributes:
label: Checklist
options:
- label: I searched the existing issues for this problem.
required: true
- label: Any data I attach may be shared publicly, and I have removed sensitive information.
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Feature request
description: Suggest an improvement or new scientific use case for SeaSenseLib
title: "[Feature]: "
body:
- type: markdown
attributes:
value: |
Thank you for suggesting an improvement. For substantial changes,
this issue can be used to agree on scope before implementation starts.

- type: textarea
id: use_case
attributes:
label: Use case
description: What scientific or technical problem would this feature solve?
validations:
required: true

- type: textarea
id: proposed_solution
attributes:
label: Proposed solution
description: Describe the behavior or interface you would like.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Describe any current workaround or alternative approach.

- type: textarea
id: context
attributes:
label: Additional context
description: Add references, examples, sketches, or sample metadata if useful.

- type: checkboxes
id: checks
attributes:
label: Checklist
options:
- label: I searched the existing issues for a similar request.
required: true
15 changes: 15 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
cff-version: 1.2.0
message: "If you use SeaSenseLib in your work, please cite it using this metadata."
title: "SeaSenseLib"
abstract: "Read, convert, and plot oceanographic sensor data."
authors:
- family-names: "Sorge"
given-names: "Yves"
orcid: "https://orcid.org/0009-0007-0043-9207"
- family-names: "Frajka-Williams"
given-names: "Eleanor"
orcid: "https://orcid.org/0000-0001-8773-7838"
doi: "10.5281/zenodo.20044197"
license: "MIT"
repository-code: "https://github.com/ocean-uhh/seasenselib"
repository-artifact: "https://pypi.org/project/seasenselib/"
131 changes: 131 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances
of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are not
aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported privately to the maintainer identified in the project metadata in
[`pyproject.toml`](pyproject.toml). Use the maintainer's contact details listed
there. All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at the [Contributor Covenant Code of Conduct][version].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][mozilla].

For answers to common questions about this code of conduct, see the
[Contributor Covenant FAQ][faq]. Translations are available on the
[Contributor Covenant translations page][translations].

[homepage]: https://www.contributor-covenant.org
[version]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[mozilla]: https://github.com/mozilla/diversity
[faq]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
94 changes: 94 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# Contributing to SeaSenseLib

Thank you for helping improve SeaSenseLib. Bug reports, documentation fixes,
tests, and code contributions are welcome. By participating, you agree to
follow our [Code of Conduct](CODE_OF_CONDUCT.md).

By submitting a contribution, you agree that it will be licensed under the
[MIT License](LICENSE) and confirm that you have the right to submit it.

For substantial changes, open an issue before starting work so that the scope
and approach can be discussed. Small, focused fixes may be submitted directly.
Please do not use public issues to report security vulnerabilities. Contact the
maintainer listed in [`pyproject.toml`](pyproject.toml) privately instead.

## Development setup

If you do not have write access to the SeaSenseLib repository, first fork it on
GitHub and clone your fork. Maintainers and collaborators with write access may
clone the main repository directly. Then create a virtual environment and
install the package with its development dependencies:

```bash
python -m venv .venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
python -m pip install --upgrade pip
python -m pip install -e ".[dev]"
```

Create a branch from the latest `main` branch and keep each pull request focused
on one change.

## Coding standards

- Follow PEP 8 and the style of the surrounding code. Use four spaces for
indentation and clear, descriptive names.
- Add docstrings to new public modules, classes, functions, and methods. Add
type hints to new public interfaces where practical.
- Preserve backward compatibility unless a breaking change has been discussed
and documented.
- For scientific or format-specific behavior, document assumptions and retain
source metadata and provenance where possible.
- Keep dependencies and test data minimal. Do not commit generated files,
credentials, private data, or data that cannot be redistributed.
- Update user documentation when behavior or public APIs change.

## Testing expectations

Run the test suite before submitting a pull request:

```bash
python -m pytest tests/
```

New features and bug fixes should include focused tests, including relevant
edge cases. A bug fix should contain a regression test that fails without the
fix. Changes to readers or writers should use the smallest redistributable test
fixture that demonstrates the behavior.

For documentation changes, also build the documentation and address warnings
introduced by the change:

```bash
make -C docs html
```

Continuous integration runs the test suite on the supported Python versions.

## Pull request checklist

- [ ] The change is focused and its purpose is clearly described.
- [ ] Relevant tests were added or updated and pass locally.
- [ ] Documentation and examples were updated where needed.
- [ ] Public API and compatibility implications are described.
- [ ] New dependencies have been justified and documented. New data files
include their sources and terms that permit redistribution.
- [ ] The branch contains no unrelated changes, generated files, or sensitive
information.
- [ ] User-facing changes are noted in the pull request description.

## Review workflow

1. Open a pull request against `main` and link any related issue. Draft pull
requests are welcome for early feedback.
2. Automated checks run on the pull request. Please resolve failures before
requesting final review.
3. A maintainer reviews the design, scientific correctness, tests,
documentation, and compatibility. Other community members may also review.
4. Address feedback with additional commits and resolve discussions with the
reviewer. Review may take more than one round.
5. A maintainer merges the pull request after the checks pass, required changes
are addressed, and at least one maintainer has approved it.

Review is collaborative. Keep discussions technical, constructive, and aligned
with the [Code of Conduct](CODE_OF_CONDUCT.md).
10 changes: 10 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Contributors

SeaSenseLib gratefully acknowledges the following contributors in addition to
the core team. Keep one row per contributor, order the rows alphabetically by
family name, and use an em dash when no ORCID is available.

| Contributor | GitHub | ORCID | First contributed release |
| --- | --- | --- | --- |
| Jonathan Mette | [@jmetteUni](https://github.com/jmetteUni) | [0009-0007-4463-2658](https://orcid.org/0009-0007-4463-2658) | 0.6.0 |
| Isabelle Schmitz | [@isaschmitz](https://github.com/isaschmitz) | [0009-0009-1369-1748](https://orcid.org/0009-0009-1369-1748) | 0.2.0 |
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -524,7 +524,12 @@ SeaSenseLib is a community-driven open source project in active development. The

### Contributing

Pull requests are welcome! Please open an issue first to discuss what you would like to change.
Pull requests are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for coding and
testing guidance and the review process. Additional community contributors are
recognized in [CONTRIBUTORS.md](CONTRIBUTORS.md). Participation is governed by
our [Code of Conduct](CODE_OF_CONDUCT.md).

To cite SeaSenseLib, use the metadata in [CITATION.cff](CITATION.cff).

### License

Expand Down
Loading
Loading