-
Notifications
You must be signed in to change notification settings - Fork 2
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Add a CONTRIBUTING.md. It should contain all relevant information to ease contributions to this repository. Especially it should explain:
- The ESJ template located in
templates/.github/workflows/ci.ymlused to generate the workflow. - The concept of parser that extract the configuration from existing files (currently only TravisCI configuration is supported through
src/utils/parse-travis-ci-config.js). - Snapshot testing with jest: How it works, how to update a snapshot (
yarn test -u) and how to verify that changes are as expected. - Fixtures located in
tests/fixturesused as test scenarios.
See #15 (comment) as an example of a question that should be answered by contributing docs.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation