Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
30 lines (24 loc) · 2.19 KB

DEVELOPMENT.md

File metadata and controls

30 lines (24 loc) · 2.19 KB

Information for developers

If you're a developer, you are welcome to submit a pull request. However, if you are not responding to an existing issue, please consider submitting an issue for discussion prior to implementation.

Read about trans-inclusive design before contributing. See the wiki for additional technical and design notes.

Development setup

  • Fork this repository, then run git clone.
  • Install Node.js, if needed, then run npm install from the project directory.
  • Follow the Chrome documentation to load the extension.
  • Prior to running any tests:
    • npm run server
  • Then run test suites as follows:
    • npm run unittest
    • npm run e2e-test
    • npm run manual-test
  • If you make changes to any code, click the Reload link on the chrome://extensions page and then reload pages using Shift-Command-R.
  • Errors will show up in the console.

To publish a new version to the Chrome Webstore

  1. Make sure all the tests pass.
  2. Update the version number in manifest.json, package.json, and package-log.json. Commit these changes to master. Use semantic versioning to determine how to increment the version number.
  3. Run npm run pack-extension to build a new zip file named dgtw-VERSION.zip.
  4. Go to Chrome Developer Dashboard, change the account to degender.the.web@gmail.com, and edit the existing app. Upload the new zip file and then publish the changes. (The button is at the very bottom.)
    • Because this Chrome extension uses content scripts, it is subject to human review. Thus publication may be "pending review" for several days.
  5. Tag the new release in GitHub and include release notes.