From de0a50127192c38a983a7bf95633e90eaa6ef652 Mon Sep 17 00:00:00 2001 From: Martin Raifer Date: Tue, 16 Nov 2021 16:36:57 +0100 Subject: [PATCH] tweak contributing instructions to keep a running changelog --- CONTRIBUTING.md | 7 ++++--- RELEASING.md | 4 ++-- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 37930e925..848a03b59 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -397,9 +397,10 @@ Make your changes to source files under `modules/`. The `iD.js` and `iD.min.js` files in this project are autogenerated - don't edit them. 1. Try your change locally. Run `npm start` and visit `localhost:8080` in a browser. -2. Run lint and tests with `npm test` -3. Commit your changes with an informative commit message -4. [Submit a pull request](https://help.github.com/articles/using-pull-requests) to the `openstreetmap/iD` project. +2. Run lint and tests with `npm test`. +3. If you feel like it, append a line describing your changes to the project's [changelog](https://github.com/openstreetmap/iD/blob/develop/CHANGELOG.md). +4. Commit your changes with an informative commit message. +5. [Submit a pull request](https://help.github.com/articles/using-pull-requests) to the `openstreetmap/iD` project. ## Using GitHub and git diff --git a/RELEASING.md b/RELEASING.md index 05ea04f25..3d896b432 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -6,7 +6,7 @@ ### Prep - If you don't have a `transifex.auth` file in the root of your iD checkout, -you'll need to create a Transifex account, ask @quincylvania or @bhousel for admin rights +you'll need to create a Transifex account, ask @tyr_asd or @bhousel for admin rights on the iD project, and then create this file with contents like
      {"user": "yourusername", "password": "*******"}
This file is not version-controlled and will not be checked in. @@ -24,7 +24,7 @@ $ npm run translations $ git add . && git commit -m 'npm run translations' ``` -- Update `CHANGELOG.md` +- Check and finalize `CHANGELOG.md` - Set release version number in `modules/core/context.js` and `package.json` ```bash