Skip to content

Commit

Permalink
Pull request templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Old-Shatterhand committed Mar 19, 2024
1 parent d48490b commit cbb5041
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/detailed_pr_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context.
List any dependencies that are required for this change.

## Fixes

Which issues/bugs/feature requests does this PR fix/tackle?

## Type of change

Please check all applicable

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected).
- [ ] This change requires a documentation update

If you tick the third one, please justify breaking DataSAILs current functionality.

# How Has This Been Tested?

Please list the added tests and what new/changed behavior they test. Please also state if you changed/added things that
are covered by already existing tests.

# Checklist:

- [ ] I have read the contribution guidelines for DataSAIL
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented my code including:
- [ ] Doc-Strings for all new methods following the
[Google Guidelines](https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings)
- [ ] Hard-to-understand areas, e.g., algorithmic steps
- [ ] I have made corresponding changes to the documentation
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing pytests pass locally with my changes
- [ ] New dependencies have been added to the recipes for conda-build (only if applicable) (check eventually for
minimal and maximal version requirements)
16 changes: 16 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/fast_pr_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context.
List any dependencies that are required for this change.

## Issue ticket number and link

Which issues/bugs/feature requests does this PR fix/tackle?

# Checklist

- [ ] I have read the contribution guidelines for DataSAIL
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented my code including Doc-Strings for all new methods following the
[Google Guidelines](https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings)

0 comments on commit cbb5041

Please sign in to comment.