-
Notifications
You must be signed in to change notification settings - Fork 0
Create pull request template for contributions #2
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
4 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 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,53 @@ | ||
| <!--- Provide a general summary of your changes in the Title above --> | ||
| <!--- Please request review from the appropriate code owners or maintainers --> | ||
|
|
||
| ## Description | ||
| <!--- Describe your changes in detail and include references --> | ||
| <!--- Please indicate any issues resolved --> | ||
|
|
||
| ## Motivation and Context | ||
| <!--- Why is this change required? What problem does it solve? --> | ||
| <!--- If it fixes an open issue, please link to the issue here. --> | ||
|
|
||
| ## Types of changes | ||
| <!--- The types are adapted from https://kapeli.com/cheat_sheets/Conventional_Commits.docset/Contents/Resources/Documents/index --> | ||
| <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> | ||
| - [ ] CI <!--- Changes to the continuous integration configuration --> | ||
| - [ ] Docs <!--- Documentation only changes --> | ||
| - [ ] Feature <!--- Non-breaking change that adds a new feature --> | ||
| - [ ] Fix <!--- Non-breaking change which addresses an issue --> | ||
| - [ ] Performance <!--- A code change that improves performance --> | ||
| - [ ] Refactor <!--- Non-breaking change that neither fixes a bug nor adds a feature --> | ||
| - [ ] Style <!--- A change that corrects the style of the code presentation --> | ||
| - [ ] Test <!--- Adding missing tests or correcting existing tests --> | ||
| - [ ] Other (**use sparingly**): <!--- Use this sparingly. Please describe the type of change. --> | ||
|
|
||
| ## Checklists: | ||
| <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
|
|
||
| **Code and Comments** | ||
| If this PR includes modifications to the code base, please select all that apply. | ||
| - [ ] My code follows the code style of this project. | ||
| - [ ] I have updated all package dependencies (if any). | ||
| - [ ] I have included all relevant files to realize the functionality of the PR. | ||
| - [ ] I have exported relevant functionality (if any). | ||
|
|
||
| **API Documentation** | ||
| - [ ] For every exported function (if any), I have included a detailed docstring. | ||
| - [ ] I have checked the spelling and grammar of all docstring updates through an external tool. | ||
| - [ ] I have checked that the docstring's function signature is correctly formatted and has all arguments. | ||
| - [ ] I have checked that the docstring's list of arguments, fields, or return values match the function. | ||
| - [ ] I have compiled the docs locally and read through all docstring updates to check for errors. | ||
vp314 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| **Manual Documentation** | ||
| - [ ] I have checked the spelling and grammar of all manual updates through an external tool. | ||
| - [ ] Any code included in the docstring is tested using doc tests to ensure consistency. | ||
vp314 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - [ ] I have compiled the docs locally and read through all manual updates to check for errors. | ||
vp314 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| **Testing** | ||
| - [ ] I have added unit tests to cover my changes. (For Macros, be sure to check | ||
| [@code_lowered](https://docs.julialang.org/en/v1/stdlib/InteractiveUtils/#InteractiveUtils.@code_lowered) and | ||
| [@code_typed](https://docs.julialang.org/en/v1/stdlib/InteractiveUtils/#InteractiveUtils.@code_typed)) | ||
| - [ ] All new and existing tests passed. | ||
| - [ ] I have achieved sufficient code coverage. | ||
|
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.