-
Notifications
You must be signed in to change notification settings - Fork 17
@uwcdc new PR template approval #181
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
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
bb5d352
Create pull_request_template.md
cdcore09 1102292
Update pull_request_template.md
cdcore09 7816548
Update pull_request_template.md
cdcore09 8f1b45a
Update pull_request_template.md
cdcore09 0da15c7
Update pull_request_template.md
cdcore09 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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| <!-- | ||
| Thank you for your contribution to the repo :) | ||
|
|
||
| Pull Request (PR) Instructions: | ||
| Provide a general summary of your changes in the Title above. Fill out each section of the template, and replace the space with an `x` in all the boxes that apply. If you're unsure about any of these, don't hesitate to ask. We're here to help! Once you are satisfied with the pull request, click the "Create pull request" button to submit it for review. | ||
|
|
||
| Before submitting this PR, please ensure that your input and responses are entered in the designated space provided below each section to keep all project-related information organized and easily accessible. | ||
|
|
||
| How to link to a PR: | ||
| https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue | ||
| --> | ||
|
|
||
| ## Change Description | ||
| <!--- | ||
| Describe your changes in detail. In your description, you should answer questions like "Why is this change required? What problem does it solve?". | ||
|
|
||
| If it fixes an open issue, please link to the issue here. If this PR closes an issue, put the word 'closes' before the issue link to auto-close the issue when the PR is merged. | ||
| --> | ||
| - [ ] My PR includes a link to the issue that I am addressing | ||
|
|
||
|
|
||
|
|
||
| ## Solution Description | ||
| <!-- Please explain the technical solution that I have provided and how it addresses the issue or feature being implemented --> | ||
|
|
||
|
|
||
|
|
||
| ## Code Quality | ||
| - [ ] I have read the [Contribution Guide](https://lincc-ppt.readthedocs.io/en/latest/source/contributing.html) | ||
| - [ ] My code follows the code style of this project | ||
| - [ ] My code builds (or compiles) cleanly without any errors or warnings | ||
| - [ ] My code contains relevant comments and necessary documentation | ||
|
|
||
| ## Project-Specific Pull Request Checklists | ||
| <!--- Please only use the checklist that apply to your change type(s) --> | ||
|
|
||
| ### Bug Fix Checklist | ||
| - [ ] My fix includes a new test that breaks as a result of the bug (if possible) | ||
| - [ ] My change includes a breaking change | ||
| - [ ] My change includes backwards compatibility and deprecation warnings (if possible) | ||
|
|
||
| ### New Feature Checklist | ||
| - [ ] I have added or updated the docstrings associated with my feature using the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html) | ||
| - [ ] I have updated the tutorial to highlight my new feature (if appropriate) | ||
| - [ ] I have added unit/End-to-End (E2E) test cases to cover my new feature | ||
| - [ ] My change includes a breaking change | ||
| - [ ] My change includes backwards compatibility and deprecation warnings (if possible) | ||
|
|
||
| ### Documentation Change Checklist | ||
| - [ ] Any updated docstrings use the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html) | ||
|
|
||
| ### Build/CI Change Checklist | ||
| - [ ] If required or optional dependencies have changed (including version numbers), I have updated the [README](https://github.com/lincc-frameworks/python-project-template/blob/main/README.md) to reflect this | ||
| - [ ] If this is a new CI setup, I have added the associated badge to the [README](https://github.com/lincc-frameworks/python-project-template/blob/main/README.md) | ||
|
|
||
| <!-- ### Version Change Checklist [For Future Use] --> | ||
|
|
||
| ### Other Change Checklist | ||
| - [ ] Any new or updated docstrings use the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html). | ||
| - [ ] I have updated the tutorial to highlight my new feature (if appropriate) | ||
| - [ ] I have added unit/End-to-End (E2E) test cases to cover any changes | ||
| - [ ] My change includes a breaking change | ||
| - [ ] My change includes backwards compatibility and deprecation warnings (if possible) | ||
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.
This section seems valuable, but I'm not sure it's immediately applicable to this project.