From 2e381a5545d0ca99abcf168770c5461c70f08651 Mon Sep 17 00:00:00 2001 From: Arthur Diniz Date: Wed, 15 Sep 2021 15:22:18 -0300 Subject: [PATCH] Template adjustments Signed-off-by: Arthur Diniz --- .github/ISSUE_TEMPLATE/bug_report_form.yml | 9 ++++----- .github/ISSUE_TEMPLATE/feature_request_form.yml | 5 ++--- .github/pull_request_template.md | 6 +++--- CONTRIBUTING.md | 10 +++++----- 4 files changed, 14 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report_form.yml b/.github/ISSUE_TEMPLATE/bug_report_form.yml index b2dafb5..648e0be 100644 --- a/.github/ISSUE_TEMPLATE/bug_report_form.yml +++ b/.github/ISSUE_TEMPLATE/bug_report_form.yml @@ -1,6 +1,5 @@ name: Bug Report description: File a bug report -title: "[Bug]: " labels: ["bug"] body: - type: markdown @@ -28,7 +27,7 @@ body: id: steps-to-reproduce attributes: label: Steps to reproduce - description: Describe the steps to reproduce + description: Describe the steps to reproduce. placeholder: 1. Step 1 ... 2. Step 2 ... 3. Step 3 ... @@ -38,7 +37,7 @@ body: id: expected-behavior attributes: label: Expected behavior - description: Describe the expected behavior + description: Describe the expected behavior. placeholder: The expected behavior is ... validations: required: false @@ -46,7 +45,7 @@ body: id: actual-behavior attributes: label: Actual behavior - description: Describe the actual behavior + description: Describe the actual behavior. placeholder: The actual behavior is ... validations: required: true @@ -71,7 +70,7 @@ body: id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](./CODE_OF_CONDUCT.md) + description: By submitting this issue, you agree to follow our [Code of Conduct](../blob/master/CODE_OF_CONDUCT.md) options: - label: I agree to follow this project's Code of Conduct required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request_form.yml b/.github/ISSUE_TEMPLATE/feature_request_form.yml index 3124978..db8f11e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request_form.yml +++ b/.github/ISSUE_TEMPLATE/feature_request_form.yml @@ -1,6 +1,5 @@ name: Feature Request description: Suggest an idea for this project -title: "[Feature-Request]: " labels: ["feature-request"] body: - type: markdown @@ -33,7 +32,7 @@ body: id: alternatives attributes: label: Alternatives - description: Describe the alternatives you've considered + description: Describe the alternatives you've considered. validations: required: false - type: textarea @@ -44,7 +43,7 @@ body: id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](../../CODE_OF_CONDUCT.md) + description: By submitting this issue, you agree to follow our Code of Conduct](../blob/master/CODE_OF_CONDUCT.md) options: - label: I agree to follow this project's Code of Conduct required: true \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c836879..a268438 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -15,9 +15,9 @@ _Put an `x` in the boxes that apply_ _Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._ -- [ ] I have read the [CONTRIBUTING](../CONTRIBUTING.md) doc -- [ ] I have added necessary documentation (if appropriate) -- [ ] Any dependent changes have been merged and published in downstream modules +- [ ] I have read the CONTRIBUTING.md doc. +- [ ] I have added necessary documentation (if appropriate). +- [ ] Any dependent changes have been merged and published in downstream modules. ## Further comments diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ea268ba..059a1e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,9 +60,9 @@ The process described here has several goals: 2. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). 3. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you. -4. Follow all instructions in [the template](./.github/pull_request_template.md) -5. Follow the [styleguides](https://github.com/jonbrouse/terraform-style-guide/blob/master/README.md) -6. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing
What if the status checks are failing?If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
+4. Follow all instructions in [the template](./.github/pull_request_template.md). +5. Follow the [styleguides](https://docs.dnx.one/docs/style-guide/terraform-style-guide.html). +6. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing.
What if the status checks are failing?If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
While the prerequisites above must be satisfied prior to have your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted. @@ -70,7 +70,7 @@ While the prerequisites above must be satisfied prior to have your pull request Unsure where to begin contributing to DNX? You can start by looking through these `beginner` and `help-wanted` issues: -* [Beginner issues][beginner] - issues that should only require a few lines of code, and a test or two. -* [Help wanted issues][help-wanted] - issues which should be a bit more involved than `beginner` issues. +* `beginner` - issues that should only require a few lines of code, and a test or two. +* `help-wanted` - issues which should be a bit more involved than `beginner` issues. Both issue lists are sorted by the total number of comments. While not perfect, the number of comments is a reasonable proxy for the impact a given change will have. \ No newline at end of file