-
Notifications
You must be signed in to change notification settings - Fork 159
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update PR template #3153
Merged
Merged
Update PR template #3153
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,61 +1,15 @@ | ||
--- | ||
name: "Bug fix or new feature" | ||
description: '' | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
# Description | ||
Please include a summary of the changes introduced by this PR. | ||
Additionally include any relevant motivation and context. List any | ||
dependencies that are required for this change, other PRs upon | ||
which this may depend, and associated issues. | ||
|
||
## Associated Pull Requests: | ||
- Make a list (with links!) | ||
- [Like this PR#691](https://github.com/OP2/PyOP2/pull/691) | ||
|
||
## Fixes Issues: | ||
- Make a list of issues (with links!) | ||
- [Like this Issue#2824](https://github.com/firedrakeproject/firedrake/issues/2824) | ||
|
||
If issues are fixed by this PR, prepend each of them with the word | ||
"fixes", so they are automatically closed when this PR is merged. For | ||
example "fixes #123, fixes #456". | ||
|
||
# Checklist for author: | ||
|
||
<!-- | ||
If you think an option is not relevant to your PR, do not delete it but use ~strikethrough formating on it~. This helps keeping track of the entire list. | ||
--> | ||
|
||
- [ ] I have linted the codebase (`make lint` in the `firedrake` source directory). | ||
- [ ] My changes generate no new warnings. | ||
- [ ] All of my functions and classes have appropriate docstrings. | ||
- [ ] I have commented my code where its purpose may be unclear. | ||
- [ ] I have included and updated any relevant documentation. | ||
- [ ] Documentation builds locally (`make linkcheck; make html; make latexpdf` in `firedrake/docs` directory) | ||
- [ ] I have added tests specific to the issues fixed in this PR. | ||
- [ ] I have added tests that exercise the new functionality I have introduced | ||
- [ ] Tests pass locally (`pytest tests` in the `firedrake` source directory) (useful, but not essential if you don't have suitable hardware). | ||
- [ ] I have performed a self-review of my own code using the below guidelines. | ||
|
||
# Checklist for reviewer: | ||
Please include a summary of the changes introduced by this PR. | ||
Additionally be sure to link associated pull requests in other projects. | ||
|
||
- [ ] Docstrings present | ||
- [ ] New tests present | ||
- [ ] Code correctly commented | ||
- [ ] No bad "code smells" | ||
- [ ] No issues in parallel | ||
- [ ] No CI issues (excessive parallelism/memory usage/time/warnings generated) | ||
- [ ] Upstream/dependent branches and PRs are ready | ||
If issues are fixed by this PR, include link to them and prepend each of them with the word "fixes", so they are automatically closed when this PR is merged. | ||
For example "fixes #xyz, fixes #abc". | ||
|
||
Feel free to add reviewers if you know there is someone who is already aware of this work. | ||
|
||
Please open this PR initially as a draft and mark as ready for review once CI tests are passing. | ||
|
||
<!-- | ||
Thanks for contributing! | ||
--> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this line necessary?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the idea of having some sort of prompt. I'd really like to have it as a form, but this is not available on github