Skip to content
This repository has been archived by the owner on Jun 15, 2021. It is now read-only.

Latest commit

 

History

History
60 lines (46 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

60 lines (46 loc) · 2.08 KB

Contributing

This advice also applies to Scribe plugins.

Finding an issue to work on

See the wiki page on labels for an explanation about how we categorise the project issues.

Assign yourself to the issue or comment on it to indicate that you are going to work on it.

Fixing an issue

Testing Locally

Please see the wiki for details of how to run the scribe test suite.

Releasing

Bower

  • git checkout master
  • Run ./release.sh [ <newversion> | major | minor | patch | build ] (we use mversion). (If releasing a plugin, run the script inside this repository from the plugin’s directory.)
  • Checkout the dist branch to check you're happy with the compilation result. If you are, run git push; git push --tags. (The dist tree is for distribution via Bower).

npm

  • git checkout master.
  • Update CHANGELOG.md
  • Update the version number in package.json
  • Commit with message of v<number>
  • git push
  • Run npm publish

Update example

  • git checkout gh-pages
  • git pull
  • Update necessary dependency versions in bower.json. Check bower ls to see which components need updating.
  • bower install
  • bower prune
  • git add --update . (don't include untracked files from source Bower components)
  • Commit using version number as the message (OR plugin version)
  • git push

Conventions

  • In documentation and code, refer to nodes by their canonical node name in uppercase. E.g. P.
  • When creating variables that refer to nodes or elements, suffix them with node or element respectively. E.g. pElement or textNode.

Tools