Skip to content

Commit edcdeb1

Browse files
kolibril13jsonvillanuevabehackl
authored
Remove "one line summary" from pr template (#1073)
* Update PULL_REQUEST_TEMPLATE.md * Improved intro section * ENH: Model acronyms after NumPy * MNT: Fixed tense of thank you message * Removed mention of acronyms in PR titles * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Benjamin Hackl <[email protected]> * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Benjamin Hackl <[email protected]> * removed wikilink from changelog.rst Co-authored-by: Jason Villanueva <[email protected]> Co-authored-by: Benjamin Hackl <[email protected]>
1 parent aa873e0 commit edcdeb1

File tree

2 files changed

+13
-16
lines changed

2 files changed

+13
-16
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
<!--
2-
Thank you for contributing to manim!
3-
4-
Please ensure that your pull request works with the latest
5-
version of manim from this repository.
2+
Thanks for your contribution to ManimCommunity!
3+
4+
Before filling in the details, ensure:
5+
- Your local changes are up-to-date with ManimCommunity/manim
6+
7+
- The title of your PR gives a descriptive summary to end-users. Some examples:
8+
- Fixed last animations not running to completion
9+
- Added gradient support and documentation for SVG files
10+
Examples of what *NOT* to do:
11+
- "fixed that styling issue" - not descriptive enough
12+
- "fixed issue #XYZ" - end-user needs to do further research
613
-->
714

815
## Motivation
@@ -16,14 +23,6 @@ For PRs introducing new features, please provide code snippets
1623
using the newly introduced functionality and ideally even the
1724
expected rendered output. -->
1825

19-
## Oneline Summary of Changes
20-
<!-- Please update the lines below with a oneline summary
21-
for your changes. It will be included in the list of upcoming changes at
22-
https://github.com/ManimCommunity/manim/wiki/Changelog-for-next-release -->
23-
```
24-
- Added new feature ... / Fixed bug ... / ... (:pr:`PR NUMBER HERE`)
25-
```
26-
2726
## Testing Status
2827
<!-- Optional (but recommended): your computer specs and
2928
what tests you ran with their results, if any. This section
@@ -35,7 +34,7 @@ that might be useful for reviewers.. -->
3534

3635
## Acknowledgements
3736
- [ ] I have read the [Contributing Guidelines](https://docs.manim.community/en/latest/contributing.html)
38-
37+
- [ ] I have chosen a descriptive PR title (see top of PR template for examples)
3938
<!-- Once again, thanks for helping out by contributing to manim! -->
4039

4140

@@ -44,4 +43,4 @@ that might be useful for reviewers.. -->
4443
- [ ] Newly added functions/classes are either private or have a docstring
4544
- [ ] Newly added functions/classes have [tests](https://github.com/ManimCommunity/manim/wiki/Testing) added and (optional) examples in the docs
4645
- [ ] Newly added documentation builds, looks correctly formatted, and adds no additional build warnings
47-
- [ ] The oneline summary has been included [in the wiki](https://github.com/ManimCommunity/manim/wiki/Changelog-for-next-release)
46+
- [ ] The PR title is descriptive enough

docs/source/changelog.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ Upcoming release
1414

1515
:Date: TBD
1616

17-
Changes for the upcoming release are tracked `in our GitHub wiki <https://github.com/ManimCommunity/manim/wiki/Changelog-for-next-release>`_.
18-
1917

2018
******
2119
v0.4.0

0 commit comments

Comments
 (0)