Skip to content

Latest commit

 

History

History
54 lines (45 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

54 lines (45 loc) · 2.48 KB
Raw

voxelcss

Code of Conduct

Please read and adhere to the code of conduct

Issues

When creating an issue, please complete the template to the best of your ability

If you would like to make a feature request or enhancement suggestion, please check the Trello board first (feel free to make a comment on a card 😄)

Pull Requests

When submitting a pull request, please give your PR a descriptive name and complete the template to the best of your ability

Note: Linux is the only actively supported platform for development (although it is probably possible to use Windows and/or Mac)

Setup

# clone repository
git clone [email protected]/jhwohlgemuth/voxelcss.git
cd voxelcss
# install project dependencies
npm install
# verify voxelcss installed correctly by running tests
npm test
# to use the "design" and "dev" tasks, install browser-sync and stmux, respectively
npm install  browser-sync stmux --global

Workflow Tasks

  • npm run dev run test and lint tasks in watch mode using stmux
  • npm test run tests
  • npm run test:watch run tests (watch mode)
  • npm run lint lint code
  • npm run lint:watch lint code (watch mode)
  • npm run design open browser to see "live" changes

Code must:

  • Be "lint free" -- npm run lint with no warnings/errors
  • Pass all tests -- npm test with no failures
  • Maintain current code coverage (within reason)
  • Be reasonable in scope and implementation details
  • Pass all automated checks:
    • Run unit and visual regression tests on Travis CI (linux)
    • Run unit tests on Appveyor (windows)
    • Calculate code coverage with coveralls.io
    • Analyze code for quality on bithound
    • Analyze code for security concerns on SNYK
    • Analyze code licenses on FOSSA