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.

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

mam pr template suggestions v1 #221

Merged
Merged
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
23 changes: 11 additions & 12 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template_berk.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ PRs will **NOT** be merged until all task coordinators (or one of their delegate

Expedition, questions, and discussion can happen at any meeting.

Delays in review & mergeing should be address in meetings or with NMDC Leadership.
Delays in review & merging should be addressed in meetings or with NMDC leadership.

# PR Information

Expand All @@ -26,17 +26,16 @@ Delays in review & mergeing should be address in meetings or with NMDC Leadershi
- [ ] Optimization
- [ ] Documentation
- [ ] Schema change: Content
- slot or class name
- slot multiplicity changes (from a single value to a list or vice versa)
- any changes to the ways slots are assigned to any classes
- creating a new slot/Class
- Enum value changes
- `slot` or `class` name
- changes to a `slot`'s `multivalued` state. `true` means the schema expects a list of values and `false` means a single value is expected.
- any changes to the ways `slot`s are assigned to any `class`es
- creating a new `slot` or `class`
- additions, removals or changes to the `permissible_values` in an `enum`
- [ ] Schema change: Cleanup
- descriptions of slots, classes, or enums
- descriptions of `slot`s, `class`es, or `enum`s
- removal of unused, commented, or invalid code
- updated mappings of terms, classes, or slots to ontologies
- added an additional Enum to accommodate new or future metadata
- [ ] Changes to any files or directories in `src/schema`
- updated `mappings` of `slot`s, `class`es, or `slot`s to ontologies
- addition of a new `enum` in the absence of making that `enum` the `range` for any existing `slot`

## Description

Expand All @@ -63,9 +62,9 @@ Delays in review & mergeing should be address in meetings or with NMDC Leadershi

> This is a question about what the schema allows. It is not a question about what happens to exists in the NMDC database right now.
>
> Example: If, in this PR branch, you renamed a slot named `foo` to `foo_bar`, the answer to this question would be "yes," **even if** nothing in the NMDC database _currently_ uses the `foo` slot.
> Example: If, in this PR branch, you renamed a `slot` from `foo` to `foo_bar`, the answer to this question would be "yes," **even if** nothing in the NMDC database _currently_ uses the `foo` `slot`.
>
> More examples: slot or class name changes, slot multiplicity changes (e.g. string versus list), slot movement from one class to another, some kinds of enum value changes.
> More examples: `slot` or `class` name changes, changes to a `slot`'s `multivalued` state, changes to a `slot`'s `range` (e.g. string to integer), changes to `slot` assignments to `class`es, changes to an `enum`'s `permissible_values`

- [ ] Yes _(A migrator is required)_
- [ ] No
Expand Down
Loading