Skip to content

Commit

Permalink
chore: Add README for new proposed release note process.
Browse files Browse the repository at this point in the history
  • Loading branch information
neilconway committed Aug 18, 2020
1 parent 2364a06 commit 4d60599
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions docs/release-notes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Release Notes

We want release notes that are accurate, comprehensive, and written so that
users of Determined can understand what has changed and what impact it has on
their use of the product. We also want to spread out the work required to write
high-quality release notes over time and across the members of the team, rather
than writing all of the release notes at the last minute as part of cutting a
new release.

## How To Write Release Notes

* Include an update to the release notes whenever you make a change that should
be communicated to users. That includes bug fixes, new features, and
improvements to existing features.

* Update the release notes as part of landing the change itself (e.g., in the
same PR or as part of a chain of PRs to land a large feature).

* Write the release note entry as a separate file and add it to the
`docs/release-notes` directory. Name the file with the PR number as a
prefix. For example, `1097-nvidia-a100-support.txt`. The file should be in
reStructuredText format and consist of one or more list elements. Be sure to
highlight API changes and backward incompatibilities, discuss any steps that
must be taken to upgrade safely, and link to other locations in the
documentation as needed. For example:

```
- Add support for provisioning Nvidia A100 GPU instances on GCP.
- Running workloads on A100 chips currently requires building a custom task
environment with CUDA 11, because the default task environments provided by
Determined contain either CUDA 10.0 or CUDA 10.1. Refer to the
:ref:`custom-env` documentation for more details. The default task
environments will be upgraded to CUDA 11 in a future release of Determined.
```

* As part of the release process, the release manager will merge these files
together into `docs/release-notes.txt`, delete the individual files from
`docs/release-notes/`, and then do additional copy-editing and formatting as
necessary.

0 comments on commit 4d60599

Please sign in to comment.