Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 3.1 KB

CONTRIBUTING.md

File metadata and controls

37 lines (27 loc) · 3.1 KB
Raw

Contributing

TL;DR

  • Before implementing a feature communicate with us via GitHub-Issues or Pull Requests. Code maintainers often have good suggestions regarding the implementation.
  • Commit any changes (new features or hot-fixes) directly against the main branch.

Getting started with browser extensions

If you never worked with browser extensions before, you should read this very nice tutorial. Alternatively you can use the instructions from mozilla. Make sure you understand the difference between content- and background-scripts, their scopes and how they can exchange information with messaging.

Working with this repo

Everything related to the browser extension can be found in /src: the manifest.json, the background.js and so on. Content scripts are in /src/contentScripts. In /src/freshContent you can find newly created content that is used in TUfast, e.g. the popup or settings-page. /docs does not contain documentation for the code, but further instructions for users of TUfast.

Steps to contribute:

  1. Create your local clone of this repo git clone <url-of-your-repo>.
  2. Create a new feature branch directly from the main branch git checkout -b <my_new_feature_branch>.
  3. Install dependencies npm ci. (You need node package manager npm installed.)
  4. Run npm run useChrome or npm run useFF to select the browser you are developing for - this will copy the corresponding manifest.json.
  5. Run npm run dev while developing. This is will compile .sass and .ts files and watch for changes in your working tree.
  6. Load the ./build directory as an unpacked extension in your browser to test the extension.
  7. Run tests locally before committing code: npm run test.
  8. Increase the version number in the manifest*.json files according to SemVer. An increase in version number is strictly required beforere releasing a new version!
  9. Create a pull request against main.
  10. Await our review.

Note: as a member of the TUfast organization you can also work in this repo directly, e.g. you can create branches and push to them, making the contribution process easier.

Used frameworks

  • Build tool: Snowpack. Run npm run dev to compile sass and ts files.
  • CSS-Preprocessor: We are using SASS.
  • ESlint: We are following standard styling with minor additions. Run npm run lint or npm run test to check your code style before committing code.

Known peculiarities with browser extensions

Error: Unchecked runtime.lastError: The message port closed before a response was received. Promisifying chrome.runtime.sendMessage({...}) doesnt work, because when you define a callback (Promise.resolve) sendMessage will wait until sendResponse is called in the message handler. It just stalls execution and then dies if it's never called. Solutions: 1) Unpromisify sendMessage. 2) Always return a value (return true is fine).

Have fun developing! 🔥