For full text search please use the '?' prefix. e.g. ? Onboarding

Ready to Ship

Summary

How to add an entry to Ready to Ship (Private).

  • NOTE: this is relevant for anyone that merges changes into master

Steps

  1. After a PR has been merged, add it to the correct triage area in the weekly ship

    From Notice Release Schedule
    Go to text →
    • NOTE: watch out for General Release window, if after the release image cutoff time, add release to weekly journal of following week

  2. Ensure that the correct type type and scope scope are assigned
  3. If the PR has multiple features, add in each feature separately. Feature breakdown should be included in the PR details when Submitting (Private) it.
  4. Ensure the format for Pull Request title (Private) is followed
  5. Add the alias of the user
  6. If the change affects user behavior, add ([[docs|{link-to-docs}]]) at the end of the message
  7. Sync your workspace (it is likely that multiple people are editing this doc)

Examples

Commit with no docs

  • NOTE: no docs needed since this doesn't introduce new behavior
enhance(publish): make publishing faster @john

Commit with docs

enhance(publish): introduce cat footer as a configurable footer @john ([[docs|dendron.topic.publish#fancy-cat-icon]])

A entire release

Checklist

Templates

Children
  1. Notice Release Schedule

Footnotes

  1. Ready to Ship (Private)˄

  2. Assign Category to Task (Private)˄

  3. Assign Scope to Feature (Private)˄

Backlinks