From 44daa4fa6bcf03f9571f41a965bcc4fed7bb3fd7 Mon Sep 17 00:00:00 2001 From: Ty Rauber Date: Thu, 10 Oct 2024 13:18:10 +0200 Subject: [PATCH] fix: update readme to remove mention of updating changelog --- .github/pull_request_template.md | 1 - RELEASE.md | 10 +--------- 2 files changed, 1 insertion(+), 10 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e5432b5fe..6da581624 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -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`) diff --git a/RELEASE.md b/RELEASE.md index 2012f7fa7..c49c2030b 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -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