docs: add contribution guidelines - #17
Merged
Merged
Conversation
Conduct, the CLA, and licensing now live in one central ESAC Data Science governance document that every project links to, so this file keeps only the project-specific technical detail: environment setup, branching model, ruff, the test commands, and the CI gates. The governance page is published, so it is linked directly rather than duplicated here.
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.
Summary
Add
CONTRIBUTING.mdfor AnomalyMatch covering only project-specific technical detail: conda environment setup, thedevelop/mainbranching model, Ruff, license headers, test commands, and CI gates.Link the guidelines from a callout near the top of the README.
Everything that is not AnomalyMatch-specific (code of conduct, CLA, licensing, general PR workflow) lives in one central document, now published:
https://www.cosmos.esa.int/web/data-science/contributing-to-our-software
CONTRIBUTING.mdpoints at it in a prominent block right under the title.This split means the CLA and conduct text is written and maintained once, and stays consistent across AnomalyMatch, Cutana, and any future project. All previously open placeholders are resolved: the governance page is live, and the CLA download link and submission address now live there rather than being duplicated per repository.
Branching model corrected
The earlier draft told contributors to target
main. Adevelopbranch has now been created on this repository and the guidelines describe the two-branch model used across our projects:developfor features, fixes, and refactors;mainfor releases and hotfixes.Note this PR still targets
main. Sincedevelopwas branched frommainand the two are currently identical,developcan be fast-forwarded after merge, or this PR retargeted todevelopif you would rather it went that way first.Test plan
CONTRIBUTING.md