Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING.md #617

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update CONTRIBUTING.md #617

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0bda403
Update CONTRIBUTING.md
pbuttigieg Oct 17, 2023
e3702ec
Update CONTRIBUTING.md
pbuttigieg Oct 17, 2023
83eba9b
Merge branch 'main' into 615-extend-contributingmd-for-devs
turbomam Nov 6, 2023
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
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ in a pull request.
* [Best Practices](#best-practices)
* [How to write a great issue](#great-issues)
* [How to create a great pull/merge request](#great-pulls)
* [Guidelines for GSC developers](#gsc-devs)

<a id="code-of-conduct"></a>

Expand Down Expand Up @@ -71,3 +72,21 @@ and make your changes on a [new branch][about-branches].
[about-pulls]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
[issues]: https://github.com/GenomicsStandardsConsortium/mixs-6-2-for-merge/issues/
[pulls]: https://github.com/GenomicsStandardsConsortium/mixs-6-2-for-merge/pulls/

<a id="gsc-devs"></a>

## Guidelines for GSC developers

If you're a GSC developer with editing rights, the advice and guidelines above still hold. You should always create an issue for each proposed change (keeping them atomic: one issue per logical change), create a branch from that issue, and - once you've made your changes on the branch - create a pull request for review and validation.

However, here are some guidelines on where and what to edit for a few routine tasks.

### Editing the MIxS specification

To edit the MIxS terms, you'll need to edit the YAML file that drives the creation of the MIxS specification in its various serialisations.
This file is located in:
`/src/mixs/schema/`

Once you've created an issue, branch, and done some editing on that branch, create a PR to have your proposed changes reviewed by the Technical WG.
Minor edits (e.g. fixing typos, clarifying edits of descriptions, etc) can be included in a patch, while any new terms or consequential edits to terms or their properties should be coordinated with minor / major release processes.