diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..e211fe2b --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,28 @@ +#### Summary: +Please provide a short couple sentence summary. + + +#### Description: +Describe the issue as clearly as possible. + + +#### Reproducible Steps: +Please report steps to reproduce the issue. If it's not possible to reproduce, please include a description of how you discovered the issue. + +If you have a reproducible example, please include it. + + +#### Current Output: +The current output. Knowing what is the current behavior is useful. + + +#### Expected Output: +Describe what you expect the output to be. Knowing the correct behavior is also very useful. + + +#### ELFI Version: + +#### Python Version: + +#### Operating System: + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..06304f21 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,19 @@ +#### Summary: + +#### Intended Effect: + +#### How to Verify: + +#### Side Effects: + +#### Documentation: + +#### Reviewer Suggestions: + +#### Copyright and Licensing + +Please list the copyright holder for the work you are submitting (this will be you or your assignee, such as a university or company): + +By submitting this pull request, the copyright holder is agreeing to license the submitted work under the following licenses: +- Code: BSD3 (https://opensource.org/licenses/BSD-3-Clause) +- Documentation: CC-BY 4.0 (https://creativecommons.org/licenses/by/4.0/) diff --git a/docs/readme.rst b/docs/readme.rst index 13bd3e15..62367aa2 100644 --- a/docs/readme.rst +++ b/docs/readme.rst @@ -20,3 +20,12 @@ Currently implemented ABC methods: GitHub page: https://github.com/HIIT/elfi See examples under the notebooks directory to get started. + +Licenses: + +- Code: BSD3_ +- Documentation: `CC-BY 4.0`_ + +.. _BSD3: https://opensource.org/licenses/BSD-3-Clause +.. _CC-BY 4.0: https://creativecommons.org/licenses/by/4.0 +