Skip to content

Latest commit

聽

History

History
27 lines (16 loc) 路 1.24 KB

CONTRIBUTING.md

File metadata and controls

27 lines (16 loc) 路 1.24 KB
Raw

Contributing

Hey there, nice to see you! 馃憢

So you want to contribute? Awesome!

(Before jumping into the hard work, please make sure you discussed the idea in an issue beforehand.)

A note about the programming language

Most of the codebase is written with Typescript (there are some bits pending in Javascript). This means that the code has to be transpiled before running and that you have to run npm run build before trying out your changes to the cli.

Don't worry if this is your first time with Typescript. The language reads like Javascript only that it is annotated with types and you're not forced to type every expression. For a quickstart tutorial you could look at Typescript in 5 minutes from the creators of the language.

Hints about integration tests

In order to run integration tests, you need:

  • a source space the tests are run against (CONTENTFUL_INTEGRATION_SOURCE_SPACE) and is called Migrations CLI Test
  • a management token for the defined space (CONTENTFUL_INTEGRATION_MANAGEMENT_TOKEN)
CONTENTFUL_INTEGRATION_SOURCE_SPACE=<spaceId> \
CONTENTFUL_INTEGRATION_MANAGEMENT_TOKEN=CFPAT-xxx \
npm test