Skip to content

Commit

Permalink
Docs(ci): Add documentation about PR requirement workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
kdvalin committed Jan 21, 2025
1 parent d7b97db commit 6400e85
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions ci/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Workflows in this repository

## Verify PR has JIRA ticket and issue number
This workflow is designed to enforce requirements for PR descriptions. At bare minimum it requires the PR to mention a related issue and mention the Jira Ticket number. Both of these are required since Sync2Jira does not know how to associate a PR with a Jira Ticket from the originating GitHub issue.


## Update parent issue
The idea behind this workflow is to keep Jira tickets in sync with the current status of their GitHub issue. A flowchart for how this works can be seen below.

Expand Down

0 comments on commit 6400e85

Please sign in to comment.