www.aleph1.co.uk Git - yaffs-website/blob - node_modules/underscore.string/CONTRIBUTING.markdown

   1
   2 # Contributing
   3
   4 - Always add tests
   5 - Update documentation if needed
   6 - Do not commit build artifacts in the `dist` directory
   7
   8 ## Bug fixes
   9
  10 Always add a test for the bug in a separate commit so we can easily cherry pick
  11 it for verification.
  12
  13 ## New features
  14
  15 It's recommended to open an issue before sending a pull request to avoid
  16 unnecessary work. There are quite few areas we consider to be out of scope for
  17 this library. Idea is to add few generic string helpers for Javascript. For
  18 example anything related to internationalization or is too language specific
  19 is out of scope.
  20
  21 ## Release checklist
  22
  23 (for maintainers)
  24
  25   - Upgrade version number `gulp bump --semver <version>`
  26   - Build the library `gulp build`
  27   - Commit build artifacts in `dist`
  28   - Write a changelog entry to `CHANGELOG.markdown`
  29     - Use Github compare to see what has changed from previous tag. Ex https://github.com/epeli/underscore.string/compare/3.0.0...master
  30   - Add git tag
  31     - `git tag -a 3.2.1 -m "3.2.1" && git push origin --tags`
  32   - [Draft][d] a new Github release for the tag
  33   - Push new release to npm
  34   - Update the [gh-pages][ghp] branch `gulp bump --semver <version> && gulp site`
  35     - You need global installation of bower for this to work
  36     - Local workaround:
  37       - `npm install bower`
  38       - `export PATH=$(pwd)/node_modules/.bin/:$PATH`
  39
  40 [d]: https://github.com/epeli/underscore.string/releases
  41 [ghp]: https://github.com/epeli/underscore.string/tree/gh-pages