Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update GitHub Issues and Pull Request Templates [ci-skip] #2531

Merged
merged 7 commits into from
Aug 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 32 additions & 3 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Bug Report
about: Create a bug report
title: "Issue title goes here"
labels: needs-triage
labels: "🐞 Issue: Bug"
assignees: ''

---
Expand All @@ -11,10 +11,39 @@ 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 issue:

```
# 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', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'master'
gem "minitest"
end

require "minitest/autorun"

class BugTest < Minitest::Test
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

```

## 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.
8 changes: 5 additions & 3 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,18 @@
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.
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.
Expand Down
19 changes: 10 additions & 9 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
Issue#
------
### Summary

Example:
<!-- Provide a general description of the code changes in your pull request.

https://github.com/faker-ruby/faker/issues/XXX
Were there any bugs you had fixed? If so, mention them: Fixes Issue #add-issue-number -->

OR
### Other Information

`No-Story`
<!-- If there's anything else that's important and relevant to your pull request, mention that information here.

Description:
------
*Describe what this PR does in a few lines. If you are adding a new faker generator, please tell us how you're going to use this object. Use cases are important because we need to make sure that our faker generators are useful. After adding the description, please delete this line.*
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#documentation).

Thanks for contributing to Faker! -->