diff options
Diffstat (limited to '')
-rw-r--r-- | .github/ISSUE_TEMPLATE/BUG.md | 39 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/FEATURE.md | 17 | ||||
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 51 |
3 files changed, 49 insertions, 58 deletions
diff --git a/.github/ISSUE_TEMPLATE/BUG.md b/.github/ISSUE_TEMPLATE/BUG.md index 99ba4b8..0bbe234 100644 --- a/.github/ISSUE_TEMPLATE/BUG.md +++ b/.github/ISSUE_TEMPLATE/BUG.md @@ -3,8 +3,8 @@ name: Bug report about: Report a problem with rest-server to help us resolve it and improve --- - <!-- + Welcome! - We kindly ask that you: 1. Fill out the issue template below - not doing so needs a good reason. @@ -24,6 +24,7 @@ for tracking bugs and feature requests directly relating to the development of the software itself, rather than the project. Thanks for understanding, and for contributing to the project! + --> @@ -31,22 +32,24 @@ Output of `rest-server --version` <!-- If using docker, output of `docker images --------------------------------- -How did you run rest-server exactly? ------------------------------------- + +Problem description / Steps to reproduce +---------------------------------------- <!-- This section should include at least: + * A description of the problem you are having with rest-server. + * The complete command line and any environment variables you used to - configure rest-server's backend access. Make sure to replace sensitive values! + configure rest-server. Make sure to replace sensitive values! * The output of the commands, what rest-server prints gives may give us much information to diagnose the problem! ---> - -What backend/server/service did you use to store the repository? ----------------------------------------------------------------- + * The more time you spend describing an easy way to reproduce the behavior (if + this is possible), the easier it is for the project developers to fix it! +--> Expected behavior @@ -56,30 +59,20 @@ Expected behavior Describe what you'd like rest-server to do differently. --> - Actual behavior --------------- <!-- -Please try to concentrate on observations, so only describe what you observed directly. +In this section, please try to concentrate on observations, so only describe +what you observed directly. --> - -Steps to reproduce the behavior -------------------------------- - -<!-- -The more time you spend describing an easy way to reproduce the behavior (if -this is possible), the easier it is for the project developers to fix it! ---> - - Do you have any idea what may have caused this? ----------------------------------------------- - -Do you have an idea how to solve the issue? -------------------------------------------- +<!-- +Did something noteworthy happen on your system, Internet connection, backend services, etc? +--> Did rest-server help you today? Did it make you happy in any way? diff --git a/.github/ISSUE_TEMPLATE/FEATURE.md b/.github/ISSUE_TEMPLATE/FEATURE.md index a1be40f..a5fc46a 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE.md +++ b/.github/ISSUE_TEMPLATE/FEATURE.md @@ -1,10 +1,10 @@ --- -name: Feature request/enhancement +name: Feature request about: Suggest a new feature or enhancement for rest-server --- - <!-- + Welcome! - We kindly ask that you: 1. Fill out the issue template below - not doing so needs a good reason. @@ -18,6 +18,7 @@ for tracking bugs and feature requests directly relating to the development of the software itself, rather than the project. Thanks for understanding, and for contributing to the project! + --> @@ -30,24 +31,22 @@ later to see what has changed in rest-server when we revisit this issue after so time. --> - -What should rest-server do differently? ---------------------------------------- +What should rest-server do differently? Which functionality do you think we should add? +--------------------------------------------------------------------------------------- <!-- -Please describe the feature you'd like to see added or changed here. +Please describe the feature you'd like us to add here. --> -What are you trying to do? What is your use case? -------------------------------------------------- +What are you trying to do? What problem would this solve? +--------------------------------------------------------- <!-- This section should contain a brief description what you're trying to do, which would be possible after implementing the new feature. --> - Did rest-server help you today? Did it make you happy in any way? ----------------------------------------------------------------- diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 574054d..00d5da1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,42 +1,41 @@ <!-- -Thank you very much for contributing code or documentation to rest-server! - -Please note that each PR should be preceded by an issue where the suggested -change can be discussed in general and without focus on specific code. That -way, work done in the PR will better match what's been agreed in the issue. - -Please fill out the following questions to make it easier for us to review -your changes. You don't have to check all the checkboxes at once, instead -feel free to add more commits over time. +Thank you very much for contributing code or documentation to rest-server! Please +fill out the following questions to make it easier for us to review your +changes. --> - -What is the purpose of this change? What does it change? --------------------------------------------------------- +What does this PR change? What problem does it solve? +----------------------------------------------------- <!-- -Describe the changes here, as detailed as needed. +Describe the changes and their purpose here, as detailed as needed. --> - -Was the change discussed in an issue or in the forum before? ------------------------------------------------------------- +Was the change previously discussed in an issue or on the forum? +---------------------------------------------------------------- <!-- Link issues and relevant forum posts here. -If this PR resolves an issue on GitHub, write "Closes #1234" such -that the issue is closed automatically when this PR is merged. +If this PR resolves an issue on GitHub, use "Closes #1234" so that the issue +is closed automatically when this PR is merged. --> - Checklist --------- -- [ ] I have enabled [maintainer edits for this PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) -- [ ] I have added tests for all changes in this PR -- [ ] I have added documentation for the changes (in the manual) -- [ ] There's a new file in `changelog/unreleased/` that describes the changes for our users (template [here](https://github.com/restic/rest-server/blob/master/changelog/TEMPLATE)) -- [ ] I have run `gofmt` on the code in all commits -- [ ] All commit messages are formatted in the same style as [the other commits in the repo](https://github.com/restic/rest-server/commits/master) -- [ ] I'm done, this Pull Request is ready for review +<!-- +You do not need to check all the boxes below all at once. Feel free to take +your time and add more commits. If you're done and ready for review, please +check the last box. Enable a checkbox by replacing [ ] with [x]. + +Please always follow these steps: +- Enable [maintainer edits](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork). +- Run `gofmt` on the code in all commits. +- Format all commit messages in the same style as [the other commits in the repository](https://github.com/restic/rest-server/blob/master/CONTRIBUTING.md#git-commits). +--> + +- [ ] I have added tests for all code changes. +- [ ] I have added documentation for relevant changes (in the manual). +- [ ] There's a new file in `changelog/unreleased/` that describes the changes for our users (see [template](https://github.com/restic/rest-server/blob/master/changelog/TEMPLATE)). +- [ ] I'm done! This pull request is ready for review. |