CONTRIBUTING.md

Talkie

Text-to-speech browser extension button

Problems?

• Report any issues with installation, usage on specific webpages, crashes, etcetera using the issue tracker.
• Please include relevant information:
  • Which browser and version you are using.
  • Which website the problem occurred on. If possible, include the full link.
  • Which text/part of the website you want spoken.
  • Which language the text was expected to be spoken in.
  • Any other information you think might be relevant in tracking down the issue.

Have a patch?

• Translations can be done by editing or adding messages.json for the desired locale in the _locales directory.
• Follow git-flow and use the develop branch as the base for your patch.
• All project contributors need to agree to the the Contributor License Agreement (CLA).

Release procedure

# Finish up any features, switch to develop.
git checkout develop

# Fix any warnings and errors.
npm run --silent test

# The "<version>" needs to follow semantic versioning, such as "v1.0.0".
# http://semver.org/
git flow release start <version>

# Update files to contain the version number.
npm run --silent version:update

# Finish the release and sign the tag.
git flow release finish -s <version>

# Create a zip file with the extension package.
npm run --silent package

# Upload and publish the package.
npm run --silent chromestore

---

Talkie Copyright © 2016 Joel Purra. Released under GNU General Public License version 3.0 (GPL-3.0).