Skip to content

CHANGELOG

Jay Zhang edited this page Apr 16, 2020 · 2 revisions

Rules

  • Follow the keepchangelog rule
  • Every PR should have at least one entry in CHANGELOG-FORK.md to describe what does it do.
    • Make sure it's easy to understand since it's for humans, not machines.
    • Format: [Type] [Contents] [Issue/PR ID], e.g.,
      • ADDED new cmd tool nodes2way-cli to able to query ways from nodes #274

Categories of changes

  • Feature:
  • Bugfix:
  • Performance:
  • Tools:
  • Docs:

Types of changes

  • ADDED for new features.
  • CHANGED for changes in existing functionality.
  • DEPRECATED for soon-to-be removed features.
  • REMOVED for now removed features.
  • FIXED for any bug fixes.
  • SECURITY in case of vulnerabilities.
Clone this wiki locally