Skip to content

Commit

Permalink
fix: update readme to remove mention of updating changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
tyrauber committed Oct 10, 2024
1 parent 1b3c371 commit 44daa4f
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 10 deletions.
1 change: 0 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ Added `your feature` that allows ...
- [ ] I formatted JS and TS files with running `yarn lint:fix` in the root folder
- [ ] I have run tests via `yarn test` in the root folder
- [ ] I updated the documentation with running `yarn generate` in the root folder
- [ ] I mentioned this change in `CHANGELOG.md`
- [ ] I updated the typings files (`index.d.ts`)
- [ ] I added/updated a sample (`/example`)

Expand Down
10 changes: 1 addition & 9 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,11 @@ If not, make sure to investigate the issue and fix it prior to a release.

Once you verified, that `master` isn't broken, go on and increase the `version` within our `package.json`.

## Update the CHANGELOG accordingly

Our [`CHANGELOG.md`](https://github.com/maplibre/maplibre-react-native/blob/master/CHANGELOG.md) should be updated whenever a PR is merged/ noteworthy changes are committed to `master`.
Prior to a release, the changes should be documented under the `UNRELEASED` section.
Once it's clear, that a release is about to be published, move the items under `UNRELEASED` to _this_ releases sections.
Let your actions be guided by the previous release entries.

## Draft a new release on Github

Within the [releases](https://github.com/maplibre/maplibre-react-native/releases) section of the repo you can [`Draft a new release`](https://github.com/maplibre/maplibre-react-native/releases/new).

`Tag version` & `Release title` should be the same.
As redundant as it might sound, please add the changes from the `CHANGELOG.md` into the body of the release.
`Tag version` & `Release title` should be the same.

## Monitor the repos issues for updates

Expand Down

0 comments on commit 44daa4f

Please sign in to comment.