Skip to content

Latest commit

 

History

History
15 lines (13 loc) · 869 Bytes

CONTRIBUTING.md

File metadata and controls

15 lines (13 loc) · 869 Bytes

Thank you for considering to make a contribution to Salinger.

Here are the things to consider:

  • Before creating a pull request, please open an issue.
  • If there is already an open issue regarding your problem, don't open another.
  • If the changes you've made decrease or doesn't pass the code quality checkers, the changes can be rejected.
  • If the changes you've made breaks the CI scripts, the changes will be rejected.
  • You can run unit tests and CI scripts locally to make sure you didn't break anything, before commit.
  • To run unit tests: npm test
  • To run travis scripts: sh scripts/travis.sh
  • To run appveyor scripts (in powershell): scripts/appveyor.ps1
  • Code style is what eslint says.
  • Put [skip ci] at the beginning of cosmetic commits' messages.
  • You can put [appveyor], [travis], [codeclimate] at the beginning of related commits' messages.