Clarify that the upgrade-notes.md file should have a header for the current release
+4
-4
@@ -17,14 +17,14 @@ Create a changelog for all merges to master since the previous release (see the
|
||||
|
||||
Edit the resulting changelog file with any summary notes or special upgrade considerations.
|
||||
|
||||
You can extract the upgrade considerations from the [`changelog/upgrade-notes.md`](https://github.com/openlayers/ol3/blob/master/changelog/upgrade-notes.md) file, by looking at the upgrade notes that are not yet assigned to a specific version.
|
||||
You can extract the upgrade considerations from the [`changelog/upgrade-notes.md`](https://github.com/openlayers/ol3/blob/master/changelog/upgrade-notes.md) file, by looking at any upgrade notes since the previous release.
|
||||
|
||||
Now edit the [`changelog/upgrade-notes.md`](https://github.com/openlayers/ol3/blob/master/changelog/upgrade-notes.md) to add a new section at head of the file, `### v3.1.0` for example.
|
||||
If the [`changelog/upgrade-notes.md`](https://github.com/openlayers/ol3/blob/master/changelog/upgrade-notes.md)
|
||||
file does not already have a header for the current release, create a header with the version number (e.g. `### v3.1.0`).
|
||||
|
||||
Commit your changes:
|
||||
|
||||
git add changelog/v3.1.0.md
|
||||
git add changelog/upgrade-notes.md
|
||||
git add changelog
|
||||
git commit -m 'Changelog for v3.1.0'
|
||||
|
||||
### Update `package.json`
|
||||
|
||||
Reference in New Issue
Block a user