BigW Consortium Gitlab

Commit 0e1ff0eb by Allison Whilden

Merge branch 'copy-guidelines-merge-requests' into 'master'

Update copy.md with issue guideline updates and merge request guidelines Update copy.md with issue guideline updates and merge request guidelines See merge request !7513
parents 400d2b7e cfabd5b5
...@@ -7,7 +7,7 @@ We are currently inconsistent with this guidance. Images below are created to il ...@@ -7,7 +7,7 @@ We are currently inconsistent with this guidance. Images below are created to il
## Contents ## Contents
* [Brevity](#brevity) * [Brevity](#brevity)
* [Forms](#forms) * [Sentence case](#sentence-case)
* [Terminology](#terminology) * [Terminology](#terminology)
--- ---
...@@ -27,52 +27,73 @@ Preferrably use context and placement of controls to make it obvious what clicki ...@@ -27,52 +27,73 @@ Preferrably use context and placement of controls to make it obvious what clicki
--- ---
## Forms ## Sentence case
Use sentence case for all titles, headings, labels, menu items, and buttons.
### Adding items ---
## Terminology
Only use the terms in the tables below.
### Issues
#### Adjectives (states)
| Term |
| ---- |
| Open |
| Closed |
| Deleted |
>**Example:**
Use `5 open issues` and don't use `5 pending issues`.
#### Verbs (actions)
| Term | Use | Don't |
| ---- | --- | --- |
| Add | Add an issue | Don't use `create` or `new` |
| View | View an open or closed issue ||
| Edit | Edit an open or closed issue | Don't use `update` |
| Close | Close an open issue ||
| Re-open | Re-open a closed issue | There should never be a need to use `open` as a verb |
| Delete | Delete an open or closed issue ||
#### Add issue
When viewing a list of issues, there is a button that is labeled `Add`. Given the context in the example, it is clearly referring to issues. If the context were not clear enough, the label could be `Add issue`. Clicking the button will bring you to the `Add issue` form. Other add flows should be similar. When viewing a list of issues, there is a button that is labeled `Add`. Given the context in the example, it is clearly referring to issues. If the context were not clear enough, the label could be `Add issue`. Clicking the button will bring you to the `Add issue` form. Other add flows should be similar.
![Add issue button](img/copy-form-addissuebutton.png) ![Add issue button](img/copy-form-addissuebutton.png)
The form should be titled `Add issue`. The submit button should be labeled `Save` or `Submit`. Do not use `Add`, `Create`, `New`, or `Save Changes`. The cancel button should be labeled `Cancel`. Do not use `Back`. The form should be titled `Add issue`. The submit button should be labeled `Submit`. Don't use `Add`, `Create`, `New`, or `Save changes`. The cancel button should be labeled `Cancel`. Don't use `Back`.
![Add issue form](img/copy-form-addissueform.png) ![Add issue form](img/copy-form-addissueform.png)
### Editing items #### Edit issue
When in context of an issue, the affordance to edit it is labeled `Edit`. If the context is not clear enough, `Edit issue` could be considered. Other edit flows should be similar. When in context of an issue, the affordance to edit it is labeled `Edit`. If the context is not clear enough, `Edit issue` could be considered. Other edit flows should be similar.
![Edit issue button](img/copy-form-editissuebutton.png) ![Edit issue button](img/copy-form-editissuebutton.png)
The form should be titled `Edit Issue`. The submit button should be labeled `Save`. Do not use `Edit`, `Update`, `New`, or `Save Changes`. The cancel button should be labeled `Cancel`. Do not use `Back`. The form should be titled `Edit issue`. The submit button should be labeled `Save`. Don't use `Edit`, `Update`, `Submit`, or `Save changes`. The cancel button should be labeled `Cancel`. Don't use `Back`.
![Edit issue form](img/copy-form-editissueform.png) ![Edit issue form](img/copy-form-editissueform.png)
---
## Terminology
### Issues ### Merge requests
#### Adjectives (states) #### Adjectives (states)
| Term | Use | | Term |
| ---- | --- | | ---- |
| Open | Issue is active | | Open |
| Closed | Issue is no longer active | | Merged |
>**Example:**
Use `5 open issues` and do not use `5 pending issues`.
Only use the adjectives in the table above.
#### Verbs (actions) #### Verbs (actions)
| Term | Use | | Term | Use | Don't |
| ---- | --- | | ---- | --- | --- |
| Add | For adding an issue. Do not use `create` or `new` | | Add | Add a merge request | Do not use `create` or `new` |
| View | View an issue | | View | View an open or merged merge request ||
| Edit | Edit an issue. Do not use `update` | | Edit | Edit an open or merged merge request| Do not use `update` |
| Close | Closing an issue | | Merge | Merge an open merge request ||
| Re-open | Re-open an issue. There should never be a need to use `open` as a verb | \ No newline at end of file
| Delete | Deleting an issue. Do not use `remove` |
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment