Update issue templates
Now that Todd will be helping with issue triage, I'm optimistically relaxing the issue requirements.
This commit is contained in:
parent
db5d4214c8
commit
47d1ca03da
|
@ -0,0 +1,86 @@
|
||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: You must provide a script that reproduces the bug, using our template.
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Thank you for your contribution!
|
||||||
|
|
||||||
|
Due to limited volunteers, issues that do not follow these instructions will be
|
||||||
|
closed without comment.
|
||||||
|
|
||||||
|
Check the following boxes:
|
||||||
|
|
||||||
|
- [ ] This is not a usage question, this is a bug report
|
||||||
|
- [ ] This bug can be reproduced with the script I provide below
|
||||||
|
- [ ] This bug can be reproduced in the latest release of the `paper_trail` gem
|
||||||
|
|
||||||
|
Due to limited volunteers, we cannot answer *usage* questions. Please ask such
|
||||||
|
questions on [StackOverflow](https://stackoverflow.com/tags/paper-trail-gem).
|
||||||
|
|
||||||
|
Bug reports must use the following template:
|
||||||
|
|
||||||
|
```ruby
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
# Use this template to report PaperTrail bugs.
|
||||||
|
# Please include only the minimum code necessary to reproduce your issue.
|
||||||
|
require "bundler/inline"
|
||||||
|
|
||||||
|
# STEP ONE: What versions are you using?
|
||||||
|
gemfile(true) do
|
||||||
|
ruby "2.5.1"
|
||||||
|
source "https://rubygems.org"
|
||||||
|
gem "activerecord", "5.2.0"
|
||||||
|
gem "minitest", "5.11.3"
|
||||||
|
gem "paper_trail", "9.2.0", require: false
|
||||||
|
gem "sqlite3", "1.3.13"
|
||||||
|
end
|
||||||
|
|
||||||
|
require "active_record"
|
||||||
|
require "minitest/autorun"
|
||||||
|
require "logger"
|
||||||
|
|
||||||
|
# Please use sqlite for your bug reports, if possible.
|
||||||
|
ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
|
||||||
|
ActiveRecord::Base.logger = nil
|
||||||
|
ActiveRecord::Schema.define do
|
||||||
|
# STEP TWO: Define your tables here.
|
||||||
|
create_table :users, force: true do |t|
|
||||||
|
t.text :first_name, null: false
|
||||||
|
t.timestamps null: false
|
||||||
|
end
|
||||||
|
|
||||||
|
create_table :versions do |t|
|
||||||
|
t.string :item_type, null: false
|
||||||
|
t.integer :item_id, null: false
|
||||||
|
t.string :event, null: false
|
||||||
|
t.string :whodunnit
|
||||||
|
t.text :object, limit: 1_073_741_823
|
||||||
|
t.text :object_changes, limit: 1_073_741_823
|
||||||
|
t.datetime :created_at
|
||||||
|
end
|
||||||
|
add_index :versions, %i[item_type item_id]
|
||||||
|
end
|
||||||
|
ActiveRecord::Base.logger = Logger.new(STDOUT)
|
||||||
|
require "paper_trail"
|
||||||
|
|
||||||
|
# STEP FOUR: Define your AR models here.
|
||||||
|
class User < ActiveRecord::Base
|
||||||
|
has_paper_trail
|
||||||
|
end
|
||||||
|
|
||||||
|
# STEP FIVE: Please write a test that demonstrates your issue.
|
||||||
|
class BugTest < ActiveSupport::TestCase
|
||||||
|
def test_1
|
||||||
|
assert_difference(-> { PaperTrail::Version.count }, +1) {
|
||||||
|
User.create(first_name: "Jane")
|
||||||
|
}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# STEP SIX: Run this script using `ruby my_bug_report.rb`
|
||||||
|
```
|
|
@ -1,10 +1,14 @@
|
||||||
---
|
---
|
||||||
name: I want to fix a bug, but need some help
|
name: I want to fix a bug, but need some help
|
||||||
about: >
|
about: 'BUG REPORTS NOT ACCEPTED. You can ask for help fixing a bug. You must provide
|
||||||
BUG REPORTS NOT ACCEPTED. You can ask for help fixing a bug. You must provide
|
a script that reproduces the bug, using our template. We''ll help, but you must
|
||||||
a script that reproduces the bug, using our template. We'll help, but you must
|
|
||||||
fix the bug yourself (prepare a PR).
|
fix the bug yourself (prepare a PR).
|
||||||
|
|
||||||
|
'
|
||||||
|
title:
|
||||||
|
labels:
|
||||||
|
assignees:
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
Thank you for your contribution!
|
Thank you for your contribution!
|
||||||
|
|
|
@ -0,0 +1,28 @@
|
||||||
|
---
|
||||||
|
name: Feature suggestion
|
||||||
|
about: Suggest a feature that you'd like to build
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Thank you for your contribution!
|
||||||
|
|
||||||
|
Due to limited volunteers, issues that do not follow this template will be
|
||||||
|
closed without comment.
|
||||||
|
|
||||||
|
**Is your feature suggestion related to a problem? Please describe.**
|
||||||
|
|
||||||
|
A clear and concise description of the problem. You may find the
|
||||||
|
[bug report template](https://github.com/paper-trail-gem/paper_trail/blob/master/.github/ISSUE_TEMPLATE/bug_report.md)
|
||||||
|
helpful.
|
||||||
|
|
||||||
|
**Describe the solution you'd like to build**
|
||||||
|
|
||||||
|
A clear and concise description of what you want to build.
|
||||||
|
|
||||||
|
**Describe alternatives you've considered**
|
||||||
|
|
||||||
|
A clear and concise description of any alternative solutions or features you've
|
||||||
|
considered.
|
|
@ -1,9 +1,12 @@
|
||||||
---
|
---
|
||||||
name: I want to build a new feature, but need help
|
name: I want to build a new feature, but need help
|
||||||
about: >
|
about: 'FEATURE REQUESTS NOT ACCEPTED. You can ask for help with something that you
|
||||||
FEATURE REQUESTS NOT ACCEPTED. You can ask for help with something that you
|
would like to build. We''ll help, but you must build it yourself (prepare a PR).
|
||||||
would like to build. We'll help, but you must build it yourself (prepare a
|
|
||||||
PR).
|
'
|
||||||
|
title:
|
||||||
|
labels:
|
||||||
|
assignees:
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue