Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 1.43 KB
Raw

Contributing Guidelines

Do follow the seven rules of a great Git commit message.

Do follow git best practices wherever possible.

Do squash the commits in your PR to remove corrections irrelevant to the code history.

Do feel free to pester the project maintainers about the PR if it hasn't been responded to. Sometimes notifications can be missed.

Don't overuse vertical whitespace; avoid multiple sequential blank lines.

Don't include more than one feature or fix in a single PR.

Don't include changes unrelated to the purpose of the PR. This includes changing the project version number, adding lines to the .gitignore file, or changing the indentation or formatting.

Don't open a new PR if changes are requested. Just push to the same branch and the PR will be updated.

Functional Tests

Uses mocha, and will only run in nodejs mode and on localhost. Steps to Run:

  1. npm install -> to grab dependencies.
  2. Add test:true to system.json.
  3. Start FoundryVTT as normal, locally.
  4. Browse to localhost version localhost:30000
  5. Log in as a GM, a new macro will be auto-generated for running functional tests.
  6. Run macro to execute tests.

Examples of how to add tests: see /tests/ffg-tests.js ==> this is the test runner. see /tests/common.test.js ==> this is a unit/functional test