I often would want to submit for a PR, and have comments / other things that need to be addressed before this is ready for a PR. While this is named ‘Am I ready to commit?’ I personally am trying to apply as much of the below as possible. In reality the below should be geared more toward making a PR; but i’m hard on myself and want to ensure each commit is meaningful.

Am I ready to commit?

Did I?

  • Meet all requirements for the Jira task / Issue / Ticket etc.
  • Ensure no linter errors messages
    • Linter messages ignored when applicable
  • Does kitchen converge run successfully?
  • Update README(s) for cookbooks / stacks
    • Add the new function / capability to README(s)
  • Spellcheck / Proofread mrc0der!

Below is a full list, properly named, ‘Am I ready for a PR?’

Am I ready for a PR?

Did I?

  • Meet all requirements for the Jira task / Issue / Ticket etc.
  • Follow any style guides required
  • Bump cookbook version(s)
    • Include new / updated cookbook in env files
  • Bump stacker blueprints version(s)
  • Bump __ version(s)
  • Update cookbooks/metadata.rb
  • Update README(s) for cookbooks / stacks
    • Add the new function / capability to README(s)
  • Spellcheck / Proofread mrc0der!
  • Update .gitignore for any non essential files
  • Did you update the CHANGELOG

Did you double and triple check the above?

  • If so, do it again, chances are you missed something…mrc0der! lol
  • Once that is done, you should be ready to submit your PR.