diff --git a/.github/ISSUE_TEMPLATE/03_enhancement.md b/.github/ISSUE_TEMPLATE/02_enhancement.md similarity index 86% rename from .github/ISSUE_TEMPLATE/03_enhancement.md rename to .github/ISSUE_TEMPLATE/02_enhancement.md index 3bb189231f84776eac24d5c148d2b45344633d0f..79463739c2dce0e683135d7c1d52b0c8a133ff9a 100644 --- a/.github/ISSUE_TEMPLATE/03_enhancement.md +++ b/.github/ISSUE_TEMPLATE/02_enhancement.md @@ -12,7 +12,8 @@ Before opening a new issue, please make sure that we do not have any duplicates ## Avoid duplicates * [ ] This enhancement request has not already been raised before -* [ ] Enhancement request is specific for Android only, for general issues / questions that apply to iOS and Android please raise them in the [documentation repository](https://github.com/corona-warn-app/cwa-documentation) +* [ ] Enhancement request is specific for Android only, for general issues / questions that apply to iOS and Android please raise them in [CWA-Wishlist](https://github.com/corona-warn-app/cwa-wishlist) +* [ ] If you are proposing a new feature, please do so in [CWA-Wishlist](https://github.com/corona-warn-app/cwa-wishlist) ## Current Implementation <!-- Describe or point to the current implementation that you would like to see improved --> diff --git a/.github/ISSUE_TEMPLATE/02_feature_request.md b/.github/ISSUE_TEMPLATE/02_feature_request.md deleted file mode 100644 index 5b1851dc29f23ee2b317ff6d7b8e65e5fe8c9048..0000000000000000000000000000000000000000 --- a/.github/ISSUE_TEMPLATE/02_feature_request.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: "\U0001F381 Feature Request" -about: Do you have an idea for a new feature? -labels: feature request - ---- -<!-- -Thanks for requesting a feature 🙌 â¤ï¸ - -Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead. ---> - -## Avoid duplicates -* [ ] Feature request is not mentioned in the [FAQ](https://www.coronawarn.app/en/faq/) -* [ ] Feature request is specific for Android only, for general issues / questions that apply to iOS and Android please raise them in the [documentation repository](https://github.com/corona-warn-app/cwa-documentation) -* [ ] Feature request is not already reported in another issue - -## Feature description - -<!--- -Provide a detailed description of the feature or improvement you are proposing. What specific solution would you like? What is the expected behaviour? - -Add any other context, screenshots, or code snippets about the feature request here as well. ---> - -## Problem and motivation -<!--- -Why is this change important to you? What is the problem this feature would solve? How would you use it? How can it benefit other users? ---> - -## Is this something you're interested in working on - -<!--- Yes or No --> diff --git a/.github/ISSUE_TEMPLATE/04_questions.md b/.github/ISSUE_TEMPLATE/03_questions.md similarity index 100% rename from .github/ISSUE_TEMPLATE/04_questions.md rename to .github/ISSUE_TEMPLATE/03_questions.md diff --git a/.github/ISSUE_TEMPLATE/05_other.md b/.github/ISSUE_TEMPLATE/04_other.md similarity index 100% rename from .github/ISSUE_TEMPLATE/05_other.md rename to .github/ISSUE_TEMPLATE/04_other.md diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 3ba13e0cec6cbbfd462e9ebf529dd2093148cd69..32c9c653099b0123cc9900344cbfe60bec7f7b23 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1,5 @@ blank_issues_enabled: false +contact_links: + - name: Feature Requests + url: https://github.com/corona-warn-app/cwa-wishlist/issues + about: Please propose new features here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index db03c1cd285b2e10302a1f3f01d5de14169a4a1e..7aab3fb4e331226065e513841448ffbc68f8a2b6 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,5 @@ -<!-- -Thank you for supporting us with your Pull Request! 🙌 â¤ï¸ +<!-- +Thank you for supporting us with your Pull Request! 🙌 â¤ï¸ Before submitting, please take the time to check the points below and provide some descriptive information. --> @@ -8,7 +8,7 @@ Before submitting, please take the time to check the points below and provide so * [ ] Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests. * [ ] If this PR comes from a fork, please [Allow edits from maintainers](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) * [ ] Set a speaking title. Format: {task_name} (closes #{issue_number}). For example: Use logger (closes # 41) -* [ ] [Link your Pull Request to an issue](https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) (if applicable) +* [ ] [Link your Pull Request to an issue](https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) - Pull Requests that are not linked to an issue with you as an assignee will be closed, except for minor fixes for typos or grammar mistakes in *documentation or code comments*. * [ ] Create Work In Progress [WIP] pull requests only if you need clarification or an explicit review before you can continue your work item. * [ ] Make sure that your PR is not introducing _unnecessary_ reformatting (e.g., introduced by on-save hooks in your IDE) * [ ] Make sure that your PR does not contain changes in text files, therefore the PR must not contain changes in values/strings/* and / or assets/* (see issue #332 for further information) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4ad6bc590d6ebdddd749e0ecf80e4ccd4055b0ed..4b37c1af039323178273fc1706e892aeaf56d730 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,9 +4,9 @@ All members of the project community must abide by the [Contributor Covenant, version 2.0](CODE_OF_CONDUCT.md). Only by respecting each other we can develop a productive, collaborative community. -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting [corona-warn-app.opensource@sap.com](mailto:corona-warn-app.opensource@sap.com) and/or a project maintainer. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting [corona-warn-app.opensource@sap.com](mailto:corona-warn-app.opensource@sap.com) and/or a project maintainer. -We appreciate your courtesy of avoiding political questions here. Issues which are not related to the project itself will be closed by our community managers. +We appreciate your courtesy of avoiding political questions here. Issues which are not related to the project itself will be closed by our community managers. ## Engaging in Our Project @@ -14,9 +14,9 @@ We use GitHub to manage reviews of pull requests. * If you are a new contributor, see: [Steps to Contribute](#steps-to-contribute) -* If you have a trivial fix or improvement, go ahead and create a pull request, addressing (with `@...`) a suitable maintainer of this repository (see [CODEOWNERS](CODEOWNERS) of the repository you want to contribute to) in the description of the pull request. +* Before implementing your change, create an issue that describes the problem you would like to solve or the code that should be enhanced. Please note that you are willing to work on that issue. -* If you plan to do something more involved, please reach out to us and send an [email](mailto:corona-warn-app.opensource@sap.com). This will avoid unnecessary work and surely give you and us a good deal of inspiration. +* The team will review the issue and decide whether it should be implemented as a Pull Request. In that case, they will assign the issue to you. If the team decides against picking up the issue, it will be closed with a proper explanation. * Relevant coding style guidelines are available in the respective sub-repositories as they are programming language-dependent. @@ -24,13 +24,17 @@ We use GitHub to manage reviews of pull requests. Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on. This is to prevent duplicated efforts from other contributors on the same issue. +Only start working on the Pull Request after the team assigned the issue to you to avoid unnecessary efforts. + If you have questions about one of the issues, please comment on them, and one of the maintainers will clarify. We kindly ask you to follow the [Pull Request Checklist](#Pull-Request-Checklist) to ensure reviews can happen accordingly. ## Contributing Code -You are welcome to contribute code in order to fix a bug or to implement a new feature. +You are welcome to contribute code in order to fix a bug or to implement a new feature that is logged as an issue. + +Only start working on the Pull Request after the team assigned the issue to you to avoid unnecessary efforts. The following rule governs code contributions: @@ -72,4 +76,4 @@ The following rule governs documentation contributions: * When creating an issue, try using one of our issue templates which already contain some guidelines on which content is expected to process the issue most efficiently. If no template applies, you can of course also create an issue from scratch. -* Please apply one or more applicable [labels](https://github.com/corona-warn-app/cwa-app-android/labels) to your issue so that all community members are able to cluster the issues better. \ No newline at end of file +* Please apply one or more applicable [labels](https://github.com/corona-warn-app/cwa-app-android/labels) to your issue so that all community members are able to cluster the issues better. diff --git a/README.md b/README.md index a52d4bc23ab8bbfac4ebf3a2609b4dc44ab57661..42b078628d6ded5db7c9c7bbfddb993db5b2e948 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,7 @@ The following channels are available for discussions, feedback, and support requ | Type | Channel | | ------------------------ | ------------------------------------------------------ | | **General Discussion** | <a href="https://github.com/corona-warn-app/cwa-documentation/issues/new/choose" title="General Discussion"><img src="https://img.shields.io/github/issues/corona-warn-app/cwa-documentation/question.svg?style=flat-square"></a> </a> | +| **Feature Requests** | <a href="https://github.com/corona-warn-app/cwa-whishlist/issues/new/choose" title="Create Feature Request"><img src="https://img.shields.io/github/issues/corona-warn-app/cwa-wishlist?style=flat-square"></a> | | **Concept Feedback** | <a href="https://github.com/corona-warn-app/cwa-documentation/issues/new/choose" title="Open Concept Feedback"><img src="https://img.shields.io/github/issues/corona-warn-app/cwa-documentation/architecture.svg?style=flat-square"></a> | | **Android App Issue** | <a href="https://github.com/corona-warn-app/cwa-app-android/issues/new/choose" title="Open Android Issue"><img src="https://img.shields.io/github/issues/corona-warn-app/cwa-app-android?style=flat-square"></a> | | **Backend Issue** | <a href="https://github.com/corona-warn-app/cwa-server/issues/new/choose" title="Open Backend Issue"><img src="https://img.shields.io/github/issues/corona-warn-app/cwa-server?style=flat-square"></a> | @@ -69,6 +70,7 @@ The German government has asked SAP and Deutsche Telekom to develop the Corona-W | Repository | Description | | ------------------- | --------------------------------------------------------------------- | | [cwa-documentation] | Project overview, general documentation, and white papers. | +| [cwa-wishlist] | Community feature requests. | | [cwa-app-ios] | Native iOS app using the Apple/Google exposure notification API. | | [cwa-app-android] | Native Android app using the Apple/Google exposure notification API. | | [cwa-server] | Backend implementation for the Apple/Google exposure notification API.| @@ -76,6 +78,7 @@ The German government has asked SAP and Deutsche Telekom to develop the Corona-W [cwa-verification-server]: https://github.com/corona-warn-app/cwa-verification-server [cwa-documentation]: https://github.com/corona-warn-app/cwa-documentation +[cwa-wishlist]: https://github.com/corona-warn-app/cwa-wishlist [cwa-app-ios]: https://github.com/corona-warn-app/cwa-app-ios [cwa-app-android]: https://github.com/corona-warn-app/cwa-app-android [cwa-server]: https://github.com/corona-warn-app/cwa-server