From 34cae57acc6f6b04d5d121ce52dd6e97f8474325 Mon Sep 17 00:00:00 2001 From: Sean Perkins Date: Thu, 3 Feb 2022 14:41:13 -0500 Subject: [PATCH] docs(contributing): update requirements for contributing (#24708) --- .github/CONTRIBUTING.md | 13 ++++++++++--- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 6 ++++-- 3 files changed, 15 insertions(+), 6 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c93dc56ffb..38e85dc9a4 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -6,6 +6,7 @@ Thanks for your interest in contributing to the Ionic Framework! :tada: - [Creating an Issue](#creating-an-issue) * [Creating a Good Code Reproduction](#creating-a-good-code-reproduction) - [Creating a Pull Request](#creating-a-pull-request) + * [Requirements](#requirements) * [Setup](#setup) * [Core](#core) + [Modifying Components](#modifying-components) @@ -41,7 +42,7 @@ Please see our [Contributor Code of Conduct](https://github.com/ionic-team/ionic ## Creating an Issue -* If you have a question about using the framework, please ask on the [Ionic Forum](http://forum.ionicframework.com/) or in the [Ionic Worldwide Slack](http://ionicworldwide.herokuapp.com/) group. +* If you have a question about using the framework, please ask on the [Ionic Forum](http://forum.ionicframework.com/) or in the [Ionic Discord](https://ionic.link/discord). * It is required that you clearly describe the steps necessary to reproduce the issue you are running into. Although we would love to help our users as much as possible, diagnosing issues without clear reproduction steps is extremely time-consuming and simply not sustainable. @@ -83,10 +84,16 @@ Without a reliable code reproduction, it is unlikely we will be able to resolve ## Creating a Pull Request -* We appreciate you taking the time to contribute! Before submitting a pull request, we ask that you please [create an issue](#creating-an-issue) that explains the bug or feature request and let us know that you plan on creating a pull request for it. If an issue already exists, please comment on that issue letting us know you would like to submit a pull request for it. This helps us to keep track of the pull request and make sure there isn't duplicated effort. +Before creating a pull request, please read our requirements that explains the minimal details to have your PR considered and merged into the codebase. -* Looking for an issue to fix? Make sure to look through our issues with the [help wanted](https://github.com/ionic-team/ionic/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) label! +### Requirements +1. PRs must reference an existing issue that describes the issue or feature being submitted. +2. PRs must have a reproduction app or the issue must include a reproduction app to verify changes against. +3. PRs must include tests covering the changed behavior or a description of why tests cannot be written. +> Note: We appreciate you taking the time to contribute! Before submitting a pull request, please take the time to comment on the issue you are wanting to resolve. This helps us prevent duplicate effort or advise if the team is already addressing the issue. + +* Looking for an issue to fix? Look through our issues with the [help wanted](https://github.com/ionic-team/ionic/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) label! ### Setup diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 90665cd466..f715831465 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -49,7 +49,7 @@ body: label: Ionic Info description: Please run `ionic info` from within your Ionic Framework project directory and paste the output below. validations: - requred: true + required: true - type: textarea attributes: label: Additional Information diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 93fa3f4b4b..be0ab4e63f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -26,9 +26,11 @@ Please check the type of change your PR introduces: ## What is the current behavior? - + -Issue Number: N/A + + +Issue Number: # ## What is the new behavior?