mirror of
https://github.com/activerecord-hackery/ransack.git
synced 2022-11-09 13:47:45 -05:00
[skip ci] Another pass through the Contributing Guide
This commit is contained in:
parent
d37516a12b
commit
36c5ffa89d
1 changed files with 9 additions and 9 deletions
|
@ -1,20 +1,20 @@
|
||||||
# Contributing to Ransack
|
# Contributing to Ransack
|
||||||
|
|
||||||
Please take a moment to review this document in order to make the contribution
|
Please take a moment to review this document to make contributing easy and
|
||||||
process easy and effective for everyone involved!
|
effective for everyone involved!
|
||||||
|
|
||||||
Ransack is an open source project and we encourage contributions.
|
Ransack is an open source project and we encourage contributions.
|
||||||
|
|
||||||
## Filing an issue
|
## Filing an issue
|
||||||
|
|
||||||
Good issue reports are extremely helpful! Please only open an issue if a bug
|
Good issue reports are extremely helpful! Please only open an issue if a bug
|
||||||
is _caused by Ransack_, is _new_ (has not already been reported), and can be
|
is caused by Ransack, is new (has not already been reported), and can be
|
||||||
_reproduced_ from the information you provide.
|
reproduced from the information you provide.
|
||||||
|
|
||||||
Please do not use the issue tracker for questions or personal support requests.
|
Please do not use the issue tracker personal support requests. Stack Overflow
|
||||||
Stack Overflow is a better place for that where a wider community can help you.
|
is a better place for that where a wider community can help you.
|
||||||
|
|
||||||
Guidelines for bug reports:
|
Steps:
|
||||||
|
|
||||||
1. **Use the GitHub issue search** — check if the issue has already been
|
1. **Use the GitHub issue search** — check if the issue has already been
|
||||||
reported.
|
reported.
|
||||||
|
@ -27,7 +27,7 @@ Guidelines for bug reports:
|
||||||
|
|
||||||
When filing an issue, please provide these details:
|
When filing an issue, please provide these details:
|
||||||
|
|
||||||
* A comprehensive list of steps to _reproduce_ the issue, or - even better - a **failing spec**.
|
* A comprehensive list of steps to reproduce the issue :smiley: or even better, a failing spec!
|
||||||
* The versions of Ruby, Rails, Ransack and your operating system and database.
|
* The versions of Ruby, Rails, Ransack and your operating system and database.
|
||||||
* Any relevant stack traces ("Full trace" preferred).
|
* Any relevant stack traces ("Full trace" preferred).
|
||||||
|
|
||||||
|
@ -118,4 +118,4 @@ Syntax:
|
||||||
* Prefer simplicity, readability, and maintainability over terseness.
|
* Prefer simplicity, readability, and maintainability over terseness.
|
||||||
* Follow the conventions you see used in the code already.
|
* Follow the conventions you see used in the code already.
|
||||||
|
|
||||||
And in case we didn't emphasize it enough: we love tests!
|
And in case we didn't emphasize it enough: We love tests!
|
||||||
|
|
Loading…
Reference in a new issue