Add more info to CONTRIBUTING

[bf4]

cc @rails-api/ams

needs a second set of eyes and some reworking

[bf4]

I'm thinking of maybe adding some stuff from https://github.com/bundler/bundler/blob/d79615ab5d13ca3c7d174f45eabdcd6ada717658/lib/bundler/friendly_errors.rb#L49-L71

   Bundler.ui.info <<-EOS.gsub(/^ {6}/, "")
      --- ERROR REPORT TEMPLATE -------------------------------------------------------
      - What did you do?
        I ran the command `#{$PROGRAM_NAME} #{ARGV.join(" ")}`
      - What did you expect to happen?
        I expected Bundler to...
      - What happened instead?
        Instead, what actually happened was...
      Error details
          #{e.class}: #{e.message}
            #{e.backtrace.join("\n            ")}
      #{Bundler::Env.new.report(:print_gemfile => false, :print_gemspecs => false).gsub(/\n/, "\n      ").strip}
      --- TEMPLATE END ----------------------------------------------------------------
    EOS

   Bundler.ui.error "Unfortunately, an unexpected error occurred, and Bundler cannot continue."

    Bundler.ui.warn <<-EOS.gsub(/^ {6}/, "")
      First, try this link to see if there are any existing issue reports for this error:
      #{issues_url(e)}
      If there aren't any reports for this error yet, please create copy and paste the report template above into a new issue. Don't forget to anonymize any private data! The new issue form is located at:
      https://github.com/bundler/bundler/issues/new
    EOS
  end

  def self.issues_url(exception)
    "https://github.com/bundler/bundler/search?q=" \
    "#{CGI.escape(exception.message.lines.first.chomp)}&type=Issues"
  end

[beauby]

This probably belongs in a FAQ no?

[beauby]

👍 Some minor comments. Awesome otherwise!

[bf4]

Clean up now with my favorite comic https://github.com/rails-api/active_model_serializers/blob/creating_an_issue/CONTRIBUTING.md

[joaomdmoura]

👍

[joaomdmoura]

LGTM! 👍 just 2 small comments

[bf4]

updated

[beauby]

Problem with grammar here (everyone...you).

[bf4]

wow, you're on fire! 🔥

[bf4]

but I'm going to write Everyone is encouraged to open issues that are affecting them:

[beauby]

has already been reported

[bf4]

Added edits in new commit for ease of review

[NullVoxPopuli]

should it be clarified that the failing test should be a PR to the AMS repo?

[bf4]

not always, but yeah

[joaomdmoura]

Just one comment abotu the docs, other then this LGTM

[bf4]

@joaomdmoura your comment seemed more appropriate to the PR section, so I put it there

[joaomdmoura]

Yup @bf4, I agree. Never meant for you put it right in there.