Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.57 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

50 lines (33 loc) · 1.57 KB

Checklist

=========

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have checked for similar issues and haven't found anything relevant.
  • This is not a security issue (which should be reported here: https://circleci.com/security/)
  • I have read Contribution Guidelines.

Changes

=======

  • Put itemized changes here, preferably in imperative mood, i.e. "Add functionA to fileB"

Rationale

=========

What was the overarching product goal of this PR as well as any pertinent history of changes

Considerations

==============

Why you made some of the technical decisions that you made, especially if the reasoning is not immediately obvious

Screenshots

============

Before

Image or [gif](https://giphy.com/apps/giphycapture)

After

Image or gif where change can be clearly seen

Here are some helpful tips you can follow when submitting a pull request:

  1. Fork the repository and create your branch from master.
  2. Run make build in the repository root.
  3. If you've fixed a bug or added code that should be tested, add tests!
  4. Ensure the test suite passes (make test).
  5. The --debug flag is often helpful for debugging HTTP client requests and responses.
  6. Format your code with gofmt.
  7. Make sure your code lints (make lint). Note: This requires Docker to run inside a local job.