Skip to content
This repository was archived by the owner on Oct 13, 2023. It is now read-only.

Commit d1e9101

Browse files
committed
doc: document development workflow
1 parent 8291e03 commit d1e9101

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,29 @@ Note: Version number is bumped and the extension is published to Chrome Web Stor
1717
This Chrome Extension is open source and free to use. It includes features and fixes proposed by several [contributors](https://github.com/adrienjoly/chrome-next-step-for-trello/graphs/contributors). Pull requests are welcome, especially on prioritized [bugs and feature requests](https://github.com/adrienjoly/chrome-next-step-for-trello/projects/1). Please don't forget to read [CONTRIBUTING.md](CONTRIBUTING.md) first.
1818

1919
[Donations](https://adrienjoly.com/donate) are not expected but always appreciated. 🤗
20+
21+
## Development workflow
22+
23+
### Setup the project locally
24+
25+
```sh
26+
$ git clone https://github.com/adrienjoly/chrome-next-step-for-trello.git
27+
$ cd chrome-next-step-for-trello
28+
$ nvm use # switches to the version of Node.js specified in the .nvmrc file
29+
$ npm install # installs development dependencies
30+
$ npm run verify # checks for errors and code style inconsistencies
31+
```
32+
33+
### Open the local version of the extension
34+
35+
1. In Chrome (or other Chromium-based web browser), open the following URL in a new tab: `chrome://extensions`
36+
1. Enable the "developer mode"
37+
1. If Next Step for Trello is already installed, disable it from that list
38+
1. Click on "Load unpacked extension", then select the `chrome-next-step-for-trello` directory where you setup the project
39+
1. Go to a Trello board, to make sure that the extension works
40+
1. Otherwise, check the page's JavaScript console for errors
41+
1. After every change, don't forget to click the "refresh" icon of the local extension, from `chrome://extensions`
42+
43+
### Release a new version on Chrome Web Store
44+
45+
This process is automated, as specified in `.github/workflows/ci.yml`.

0 commit comments

Comments
 (0)