Skip to content

README.md

Latest commit

 

History

History
33 lines (26 loc) · 1.51 KB

README.md

File metadata and controls

33 lines (26 loc) · 1.51 KB

Directory of draft logs to help prepare the upcoming CHANGELOG

Every pull request should add at least one markdown file to this directory. The filename must start with a number, preferably the PR number, followed by one of these:

  1. _fix.md to propose a bug fix
  2. _add.md to propose new features
  3. _remove.md to propose a feature removal
  4. _change.md to propose a minor/major change
  5. _deprecate.md to propose a feature be deprecated

If your PR falls into more than one category - for example adding a new feature and changing an existing feature - you should include each in a separate file.

Example filename and content for PR numbered 5546 for adding a new feature

  • filename: 5546_add.md
  • content:
 - Add `icicle` trace type [[#5546](https://github.com/plotly/plotly.js/pull/5546)]

which would render

  • Add icicle trace type [#5546]

Please start your single-line or multiple lined message with a verb.

Each entry must include a link back to the PR in the form shown above: [[#1234](https://github.com/plotly/plotly.js/pull/1234)] (a link to /issues/1234 is also accepted, since GitHub redirects between the two).

Skipping the draftlog

A CI check enforces that every pull request adds a new file under draftlogs/. If your PR genuinely does not warrant a CHANGELOG entry (e.g. a CI-only change, internal refactor, or docs typo), add the no-draftlog label to the PR to opt out.