Skip to content

Commit

Permalink
Add GitHub issue and pull request templates
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastian-meyer committed Dec 4, 2019
1 parent aac9422 commit 06c0b04
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Bug Report
about: Create a report to help us improve.
title: ""
labels: bug
assignees: kitodo/kitodo-presentation-maintainers
---

## Description

A clear and concise description of what the bug is.

## Reproduction

Steps to reproduce the behaviour:

1. Go to ...
2. Click on ...
3. Scroll down to ...
4. See error

## Expected Behavior

A clear and concise description of what you expected to happen.

## Screenshots and Examples

If applicable, add screenshots and/or provide examples to help explain your problem.

## Environment

- OS version: [e.g. Windows Server 2019, Debian Linux 10.2]
- RDBMS version: [e.g. MySQL 8.0.16, MariaDB 10.4.10]
- Apache Solr version: [e.g. 8.3.0]
- TYPO3 version: [e.g. 8.7.29]
- PHP version: [e.g. 7.3.11]

## Additional Context

Add any other context about the problem here.
37 changes: 37 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
Fixes # (please link the issue)

## Description

A summary of the changes and which issue is fixed. Please also include relevant motivation and context (if that's not part of the linked issue). List any new dependencies that are required for this to work and any breaking changes that would cause existing functionality to not work as expected.

## Sponsorship

The development was paid for by ...

## Testing and Review

If applicable, provide a working demo to help us review the changes. Alternatively, describe the tests that you ran to verify your changes and provide instructions so we can reproduce.

### Environment

- OS version: [e.g. Windows Server 2019, Debian Linux 10.2]
- RDBMS version: [e.g. MySQL 8.0.16, MariaDB 10.4.10]
- Apache Solr version: [e.g. 8.3.0]
- TYPO3 version: [e.g. 8.7.29]
- PHP version: [e.g. 7.3.11]

## Migration

Describe all necessary migration steps when applying this change to production. If possible, provide scripts and documentation to automate or at least support migration.

## Checklist

I have performed a self-review of my own code and can verify that:

- [ ] My code follows the style guidelines of this project
- [ ] I have documented my code following the phpDoc standard
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation (or verified that none are needed)
- [ ] My pull request meets any applicable [Codacy](https://app.codacy.com/manual/Kitodo/Kitodo.Presentation/pullRequests) and [Scrutinizer](https://scrutinizer-ci.com/g/kitodo/kitodo-presentation/inspections) patterns
- [ ] My changes generate no new warnings or errors
- [ ] I have thoroughly tested to make sure nothing breaks and everything works as expected

0 comments on commit 06c0b04

Please sign in to comment.