Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 762 Bytes

CONTRIBUTING.md

File metadata and controls

19 lines (14 loc) · 762 Bytes

How to contribute

Contributions are welcome, but please don't send Pull requests which just update the version. For updates, create issue and we'll handle the update ourselves.

Please file bug reports and feature requests to https://github.com/metosin/ring-swagger-ui/issues.

Commit messages

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
    • "Add x", "Fix y", "Support z", "Remove x"
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why vs. how

For comprehensive explanation read this post by Chris Beams.