From 2cde023b7df6f3eb138fc5f915703b2186104049 Mon Sep 17 00:00:00 2001 From: Stefanni Brasil Date: Tue, 9 Aug 2022 14:35:45 -0700 Subject: [PATCH 1/7] Update Pull Request Template --- .github/PULL_REQUEST_TEMPLATE.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d08235e3ca..74566b3968 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,14 +1,15 @@ -Issue# ------- +### Summary -Example: + -OR +### Other Information -`No-Story` + \ No newline at end of file From 04c0b5fc5e24c5c39437768dea8413dc833ea3c4 Mon Sep 17 00:00:00 2001 From: Stefanni Brasil Date: Tue, 9 Aug 2022 14:39:17 -0700 Subject: [PATCH 2/7] Update Feature Request Template --- .github/ISSUE_TEMPLATE/feature-request.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 9d586122fc..15d3ee24e6 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -2,16 +2,16 @@ name: Feature Request about: Suggest a new feature title: "Title goes here" -labels: enhancement +labels: "💡 Issue: Feature Request" assignees: '' --- -**Is your feature request related to a problem? Please describe.** +**Is your feature request related to a problem? Please describe it.** A clear and concise description of what the problem is. **If you're adding new objects, please describe how you would use them** -A clear and concise description of examples that could be used with your new Faker methods. +Provides examples of how the proposed feature could be useful in a real project. **Describe alternatives you've considered** A clear and concise description of any alternative solutions or features you've considered. From f759e3e8f8b33475ef5c284445f9b90edf1bba17 Mon Sep 17 00:00:00 2001 From: Stefanni Brasil Date: Tue, 9 Aug 2022 15:59:08 -0700 Subject: [PATCH 3/7] Add Reproduction Script to Bug Report Template --- .github/ISSUE_TEMPLATE/bug-report.md | 32 +++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 6ffb94c4a2..98b183282e 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -2,7 +2,7 @@ name: Bug Report about: Create a bug report title: "Issue title goes here" -labels: needs-triage +labels: "🐞 Issue: Bug" assignees: '' --- @@ -11,10 +11,36 @@ assignees: '' A clear and concise description of what the bug is. ## To Reproduce -Describe the steps to reproduce the behavior. +Describe a way to reproduce your bug. To get the Faker version, run `FAKER::VERSION`. + +Use the reproduction script below to reproduce the steps: + +``` +# frozen_string_literal: true + +require "bundler/inline" + +gemfile(true) do + source "https://rubygems.org" + + git_source(:github) { |repo| "https://github.com/#{repo}.git" } + + gem "faker", github: "faker-ruby/faker", branch: "master" + gem "minitest" +end + +require "minitest/autorun" + +class BugTest < Minitest::Test + def test_bug + refute "".present? + end +end + +``` ## Expected behavior A clear and concise description of what you expected to happen. ## Additional context -Add any other context about the problem here. +Add any other additional information about the problem here. From 17a0504087e8db0fa8ab36d6df39204b9f0f17eb Mon Sep 17 00:00:00 2001 From: Stefanni Brasil Date: Tue, 9 Aug 2022 16:05:21 -0700 Subject: [PATCH 4/7] Update Feature Request Template --- .github/ISSUE_TEMPLATE/feature-request.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 15d3ee24e6..6683334ffe 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -11,7 +11,9 @@ assignees: '' A clear and concise description of what the problem is. **If you're adding new objects, please describe how you would use them** -Provides examples of how the proposed feature could be useful in a real project. +Provide examples of how the proposed feature could be useful and relevant. + +For example, if proposing a new generator, explain why it's useful and relevant to Faker, and examples of how to use it in a real project. **Describe alternatives you've considered** A clear and concise description of any alternative solutions or features you've considered. From 22160e314637ce5904203b5d164562965b996c36 Mon Sep 17 00:00:00 2001 From: Stefanni Brasil Date: Wed, 10 Aug 2022 11:23:57 -0700 Subject: [PATCH 5/7] Add link to Documentation section --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 74566b3968..4497bf634d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -10,6 +10,6 @@ Were there any bugs you had fixed? If so, mention them: Fixes Issue #add-issue-n If you are creating a new generator, share how you are going to use it. Use cases are important to make sure that our faker generators are useful. Also, add `@faker.version next` to help users know when a generator was added. See [this example](https://github.com/faker-ruby/faker/blob/aa31845ed54c25eb2638d716bfddf59771b502aa/lib/faker/music/opera.rb#L68). -Finally, if your pull request affects documentation, please follow the [Guidelines](https://github.com/faker-ruby/faker/blob/master/CONTRIBUTING.md). +Finally, if your pull request affects documentation, please follow the [Guidelines](https://github.com/faker-ruby/faker/blob/master/CONTRIBUTING.md#documentation). Thanks for contributing to Faker! --> \ No newline at end of file From d7a4f8fed3db344bbb58b83dbd470de257122a8f Mon Sep 17 00:00:00 2001 From: Stefanni Brasil Date: Wed, 10 Aug 2022 12:38:30 -0700 Subject: [PATCH 6/7] Use gem as in documentation --- .github/ISSUE_TEMPLATE/bug-report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 98b183282e..253f8fcdd7 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -25,7 +25,7 @@ gemfile(true) do git_source(:github) { |repo| "https://github.com/#{repo}.git" } - gem "faker", github: "faker-ruby/faker", branch: "master" + gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'master' gem "minitest" end From 5190313e4dc2fa8f6464ec3653e3e8a33202ec85 Mon Sep 17 00:00:00 2001 From: Stefanni Brasil Date: Wed, 10 Aug 2022 13:48:28 -0700 Subject: [PATCH 7/7] Use a real Faker example --- .github/ISSUE_TEMPLATE/bug-report.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 253f8fcdd7..d8233ae1a8 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -13,7 +13,7 @@ A clear and concise description of what the bug is. ## To Reproduce Describe a way to reproduce your bug. To get the Faker version, run `FAKER::VERSION`. -Use the reproduction script below to reproduce the steps: +Use the reproduction script below to reproduce the issue: ``` # frozen_string_literal: true @@ -32,8 +32,11 @@ end require "minitest/autorun" class BugTest < Minitest::Test - def test_bug - refute "".present? + def test_faker + # CHANGEME - Reproduce the issue here. Here's an example: + @tester = Faker::TvShows::SiliconValley + refute_empty @tester.company + assert @tester.company == "Intersite" end end