feat: Improve community readiness and open source compliance - #141
Merged
ysorge merged 2 commits intoAug 13, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves SeaSenseLib’s community readiness and open-source compliance posture by adding standard community health files (contributing guidance, code of conduct, citation metadata, and issue templates) and aligning project metadata accordingly.
Changes:
- Add community documentation: CONTRIBUTING guide, Code of Conduct, CONTRIBUTORS list, and CITATION metadata.
- Update README to point contributors/users to the new community and citation resources.
- Update
pyproject.tomlmetadata (version bump and license metadata) and add GitHub issue templates.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates the Contributing section to link to CONTRIBUTING, CONTRIBUTORS, Code of Conduct, and CITATION metadata. |
| pyproject.toml | Bumps version to 0.6.1 and updates licensing/build metadata. |
| CONTRIBUTORS.md | Adds a maintained contributors table and contribution-recording guidance. |
| CONTRIBUTING.md | Adds contribution workflow, coding/testing standards, and a PR checklist. |
| CODE_OF_CONDUCT.md | Adds a Contributor Covenant-based Code of Conduct for community governance. |
| CITATION.cff | Adds citation metadata (authors/DOI/repository links) for academic and software citation. |
| .github/ISSUE_TEMPLATE/feature_request.yml | Introduces a structured feature request template. |
| .github/ISSUE_TEMPLATE/config.yml | Enables blank issues configuration. |
| .github/ISSUE_TEMPLATE/bug_report.yml | Introduces a structured bug report template. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.