Skip to content

Add "Docs update" to workflow #746

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

Merged
merged 6 commits into from
Oct 5, 2018
Merged

Add "Docs update" to workflow #746

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1476796
workflow: target update definition
0xc0170 Sep 25, 2018
79e56f7
workflow: add docs update PR type
0xc0170 Sep 25, 2018
4a6c4b5
workflow: test update definition
0xc0170 Sep 25, 2018
b88b573
workflow: fix PR template
0xc0170 Sep 25, 2018
8b03e03
workflow: test update word fix
0xc0170 Sep 26, 2018
47eb822
Copy edit workflow.md
Oct 5, 2018
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
27 changes: 21 additions & 6 deletions docs/reference/contributing/guidelines/workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,9 @@ Refactors are intended for feature releases, if they are not fixing specific iss

Release: feature

#### New target
#### Target update

Adding a new target is a change for a patch release because it updates the targets folder implementation.
Updating target implementation (adding a new target or updating already supported target) is a change for a patch release.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updating target implementation -> Updating a target implementation


Release: patch

Expand All @@ -119,6 +119,18 @@ We consider adding a new functionality to be a feature. It does not matter if it

Release: feature

#### Docs update

Documentation changes to markdown files or doxygen documentation (comment-only changes).

Release: patch

#### Test update

Adding a new test unit or test case.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about updating or removing?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll change it to "update"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed, let me know if its OK


Release: patch

#### Breaking change

A breaking change is any change that results in breaking user space. It should have strong justification for us to consider it. Often, such changes can be backward compatible, for example, deprecating the old functionality and introducing the new replacement.
Expand All @@ -142,10 +154,13 @@ You can see test results [here](just an example).

# Pull request type

[x] Fix
[ ] Refactor
[ ] New Target
[ ] Feature
[X] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[ ] Docs update
[ ] Test update
[ ] Breaking change

```

Expand Down