Skip to content

Commit 4b5e7c4

Browse files
committed
chore: Update pull request templates
1 parent 8eaf585 commit 4b5e7c4

4 files changed

Lines changed: 47 additions & 14 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: "Pull request"
3+
about: "Open a pull request"
4+
title: "<type>: <title>"
5+
---
6+
7+
## Description
8+
<!--
9+
Thank you so much for your PR! To help us review your contribution, please consider the following points:
10+
11+
- The PR title should include one of the following Conventional Commits type specifier indicating the type of contribution:
12+
+ `feat`: new non-breaking feature ()
13+
+ `feat!`: new breaking feature
14+
+ `fix`: bug fix
15+
+ `docs`: changes to documentation
16+
+ `test`: changes to tests
17+
+ `refactor`: changes to code that leave functionality unchanged
18+
+ `chore`: miscellaneous changes to project
19+
20+
- The PR title should summarize the changes, for example "feat: Add new group argument for the pair plot".
21+
Avoid non-descriptive titles such as "Addresses issue #348".
22+
23+
- The description should provide at least 1-2 sentences describing the pull request in detail and
24+
link to any relevant issues.
25+
26+
## Checklist
27+
<!-- Feel free to remove check-list items aren't relevant to your change -->
28+
29+
- [ ] PR follows [official](https://github.com/arviz-devs/ArviZ.jl/blob/main/CONTRIBUTING.md#pull-request-checklist) PR format
30+
- [ ] The new feature is properly documented with an example.
31+
- [ ] New or updated tests cover the new feature.
32+
- [ ] Code style is correct (formatted using JuliaFormatter with BlueStyle).
33+
- [ ] Changes are listed in the appropriate section of the [changelog](https://github.com/arviz-devs/PosteriorStats.jl/blob/main/CHANGELOG.md#vv0xx-unreleased).
34+
- [ ] The patch version number been incremented if the change is non-breaking or the minor version number been incremented if the change is breaking.

.github/PULL_REQUEST_TEMPLATE/bug-fix.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ consider the following points:
2323
## Checklist
2424
<!-- Feel free to remove check-list items aren't relevant to your change -->
2525

26-
- [ ] Does the PR follow [official](https://github.com/arviz-devs/ArviZ.jl/blob/main/CONTRIBUTING.md#pull-request-checklist) PR format?
27-
- [ ] Does the PR include new or updated tests to prevent issue recurrence?
28-
- [ ] Is the code style correct (formatted using JuliaFormatter with BlueStyle)?
29-
- [ ] Is the fix listed in the [Fixes](https://github.com/arviz-devs/PosteriorStats/blob/main/CHANGELOG.md#Fixes) section of the changelog?
30-
- [ ] Has the patch version number been incremented?
26+
- [ ] PR follows [official](https://github.com/arviz-devs/ArviZ.jl/blob/main/CONTRIBUTING.md#pull-request-checklist) PR format.
27+
- [ ] The PR includes new or updated tests to prevent issue recurrence.
28+
- [ ] Code style is correct (formatted using JuliaFormatter with BlueStyle).
29+
- [ ] The fix is listed in the [Fixes](https://github.com/arviz-devs/PosteriorStats/blob/main/CHANGELOG.md#Fixes) section of the changelog.
30+
- [ ] The patch version number has been incremented.

.github/PULL_REQUEST_TEMPLATE/documentation.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,5 @@ consider the following points:
2323
## Checklist
2424
<!-- Feel free to remove check-list items aren't relevant to your change -->
2525

26-
- [ ] Does the PR follow [official](https://github.com/arviz-devs/arviz/blob/main/CONTRIBUTING.md#pull-request-checklist)
27-
PR format?
28-
- [ ] Is the new feature listed in the [Documentation](https://github.com/arviz-devs/PosteriorStats.jl/blob/main/CHANGELOG.md#Documentation) section of the changelog?
26+
- [ ] PR follows [official](https://github.com/arviz-devs/arviz/blob/main/CONTRIBUTING.md#pull-request-checklist) PR format.
27+
- [ ] The docs change is listed in the [Documentation](https://github.com/arviz-devs/PosteriorStats.jl/blob/main/CHANGELOG.md#Documentation) section of the changelog.

.github/PULL_REQUEST_TEMPLATE/new-feature.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ consider the following points:
2323
## Checklist
2424
<!-- Feel free to remove check-list items aren't relevant to your change -->
2525

26-
- [ ] Does the PR follow [official](https://github.com/arviz-devs/ArviZ.jl/blob/main/CONTRIBUTING.md#pull-request-checklist) PR format?
27-
- [ ] Is the new feature properly documented with an example?
28-
- [ ] Does the PR include new or updated tests to cover the new feature?
29-
- [ ] Is the code style correct (formatted using JuliaFormatter with BlueStyle)?
30-
- [ ] Is the new feature listed in the [Features](https://github.com/arviz-devs/PosteriorStats.jl/blob/main/CHANGELOG.md#Features) section of the changelog if the change is non-breaking or the [BREAKING CHANGES](https://github.com/arviz-devs/PosteriorStats.jl/blob/main/CHANGELOG.md#BREAKING-CHANGES) section if it is breaking?
31-
- [ ] Has the patch version number been incremented if the change is non-breaking or the minor version number been incremented if the change is breaking?
26+
- [ ] PR follows [official](https://github.com/arviz-devs/ArviZ.jl/blob/main/CONTRIBUTING.md#pull-request-checklist) PR format
27+
- [ ] The new feature is properly documented with an example.
28+
- [ ] New or updated tests cover the new feature.
29+
- [ ] Code style is correct (formatted using JuliaFormatter with BlueStyle).
30+
- [ ] The new feature is listed in the [Features](https://github.com/arviz-devs/PosteriorStats.jl/blob/main/CHANGELOG.md#Features) section of the changelog if the change is non-breaking or the [BREAKING CHANGES](https://github.com/arviz-devs/PosteriorStats.jl/blob/main/CHANGELOG.md#BREAKING-CHANGES) section if it is breaking.
31+
- [ ] The patch version number been incremented if the change is non-breaking or the minor version number been incremented if the change is breaking.

0 commit comments

Comments
 (0)