Skip to content

Commit

Permalink
Added a PR template and an "in progress" changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
Sylvain MARIE committed Oct 20, 2023
1 parent 89fea9e commit a93b750
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
This Pull request fixes #xx, fixes #yy, fixes #zz

- [ ] I completed the issue numbers (#xx) in the sentence above. The word "fixes" should remain in front of each issue
- [ ] My PR is tagged as draft when I'm still working on it, and I remove the draft flag when it is ready for review.
- [ ] I added one or several `changelog.md` entries in the appropriate "in progress" section (not the last release one)

### b - My PR adds some features:

*(Delete this section if not relevant)*

- [ ] Each issue is well-described, well-labeled and explains/agrees on the expected solution (high-level).
- [ ] I added documentation gallery examples showing the new features
- [ ] I created tests for each new feature. In particular I have for each feature:
- [ ] nominal tests (several simple ones or a parametrized one, or both)
- [ ] edge tests (valid but very particular cases, for example empty data, daylight savings change day, sparse matrix, etc.)
- [ ] error tests (in which case use `with pytest.raises(MyErrorType, match="...")`)

### b - My PR fixes some issues:

*(Delete this section if not relevant)*

- [ ] Each issue is well-described, well-labeled, and contains reproducible code examples.
4 changes: 4 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

### 0.7.9 - (In Progress)

- TBD

### 0.7.8 - Bugfixes

- Fixed `Plugin 'gallery' option 'binder': Sub-option 'org': Required configuration not provided.`. Fixes [#62](https://github.com/smarie/mkdocs-gallery/issues/62)
Expand Down

0 comments on commit a93b750

Please sign in to comment.