From eb2d0c389bf3a39f36dd726bf4097501f1b83cef Mon Sep 17 00:00:00 2001 From: Oliver Date: Wed, 25 Sep 2024 10:33:40 +0200 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5bf30e3..7e7cf00 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,16 +14,17 @@ Everything related to the browser extension can be found in `/src`: `manifest.js Steps to contribute (that's standard [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)): -1. Create a local clone of this repo `git clone ` -2. Checkout develop branch `git checkout develop` -3. Create new feature branch from develop `git checkout -b ` -4. Install dependencies `npm ci` - you need node package manager npm installed -5. Run `npm run useChrome` or `npm run useFF` to select the browser you are developing for - this will copy the corresponding manifest.json -6. Run `npm run dev` while developing. This is will compile sass and ts files and watch for changes in your working tree. -7. Load the ./build directory as an unpacked extension in your browser -8. Run tests locally before committing code `npm run test` -9. Create a pull request against `develop` -10. Await our review +1. Create a local clone of this repo `git clone `. +2. Checkout develop branch `git checkout develop`. +3. Create new feature branch from develop `git checkout -b `. +4. Install dependencies `npm ci`. (You need node package manager `npm` installed.) +5. Run `npm run useChrome` or `npm run useFF` to select the browser you are developing for - this will copy the corresponding manifest.json. +6. Run `npm run dev` while developing. This is will compile `.sass` and `.ts` files and watch for changes in your working tree. +7. Load the `./build` directory as an unpacked extension in your browser to test the extension. +8. Run tests locally before committing code: `npm run test`. +9. **Increase the version number of the package according to [SemVer](https://semver.org/).** +10. Create a pull request against `develop`. +11. Await our review. **Note:** as a member of TUfast you can work in this repo directly, e.g. you can create branches and push to them, making the contribution process easier.