Skip to content

Commit

Permalink
Update github templates
Browse files Browse the repository at this point in the history
The main change is documenting the title-checker requirements in the PR
template
  • Loading branch information
sbliven authored and Junjiequan committed Oct 23, 2024
1 parent 473d23d commit 43193bf
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 30 deletions.
28 changes: 13 additions & 15 deletions .github/ISSUE_TEMPLATE/issue-template.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,23 @@
---
name: Issue template
about: Describe this issue purpose here.

about: Generic template for backend issues
---

## Issue Name (title)
Please enter the title for this github issue
## Summary
<!-- Description of the issue -->

### Summary
Description of the issue
## Steps to Reproduce
<!-- Describe how to reproduce the issue -->

### Steps to Reproduce
Describe how to reproduce the issue
## Current Behaviour
<!-- Describe the current behavior if it is relevant -->

### Current Behaviour
Describe the current behavior if it is relevant
## Expected Behaviour
<!-- Describe the expected behavior if it is relevant -->

### Expected Behaviour
Describe the expected behavior if it is relevant
## Details
<!-- Provide all the details related to this issue. Also include screenshots, wireframes or mockups if they help.
Link related issues in the frontend or other repositories if relevant. -->

### Details
Provide all the details related to this issue. Also include screenshots, wireframes or mockups if they help.

__PS__: make sure to add the proper tags to the issue
<!-- P.S. Make sure to add the proper tags to the issue -->
35 changes: 21 additions & 14 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,38 @@
## Description
<!--
Follow semantic-release guidelines for the PR title, which is used in the changelog.
Short description of the pull request
Title should follow the format `<type>(<scope>): <subject>`, where
- Type is one of: build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test|BREAKING CHANGE
- Scope (optional) describes the place of the change (eg a particular milestone) and is usually omitted
- subject should be a non-capitalized one-line description in present imperative tense and not ending with a period
## Motivation
See https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines for more details.
-->

Background on use case, changes needed
## Description
<!-- Short description of the pull request -->

## Fixes:
Please provide a list of the fixes implemented by this PR
## Motivation
<!-- Background on use case, changes needed -->

* Items added
## Fixes
<!-- Please provide a list of the issues fixed by this PR -->

* Bug fixed (#X)

## Changes:
Please provide a list of the changes implemented by this PR
<!-- Please provide a list of the changes implemented by this PR -->

* changes made

## Tests included

- [ ] Included for each change/fix?
- [ ] Passing? (Merge will not be approved unless this is checked)
- [ ] Passing? <!-- Merge will not be approved unless tests pass -->

## Documentation
- [ ] swagger documentation updated \[required\]
- [ ] official documentation updated \[nice-to-have]
- [ ] swagger documentation updated (required for API changes)
- [ ] official documentation updated

### official documentation info
If you have updated the official documentation, please provide PR # and URL of the pages where the updates are included


<!-- If you have updated the official documentation, please provide PR # and URL of the updated pages -->
2 changes: 1 addition & 1 deletion .github/pr-title-checker-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
},
"MESSAGES": {
"success": "All OK",
"failure": "PR title not following the semantic-release guidelines. Please check https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines for more information.",
"failure": "PR title not following the semantic-release guidelines (<type>(<scope>): <subject>). Please check https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines for more information.",
"notice": ""
}
}

0 comments on commit 43193bf

Please sign in to comment.