CONTRIBUTING.md

Contributing

We follow the nteract CONTRIBUTING.md processes. If you have any difficulty, please let us know. Happy Contributing 😄

Local Development

For expedited development, you can run:

yarn install
yarn styleguide

The data explorer documentation will be run live locally on http://localhost:6060/, and you can experiment with the settings and data.

Now you are ready to contribute 🎉 !

Commit messages

This project uses conventional-changelog guidelines for writing commit messages. After you make your change, run this command for an interactive prompt.

yarn run commit

Consistent formatting allows us to keep the changelog up to date automatically, and ensures future developers have a readable timeline of changes over time. For more information, see the commitizen project page.

How Publishing works

Publishing

Publishing is handled by a 2-branch pre-release process, configured in release.yml. All changes should be based off of the default next branch. Changes are automatically published to the next channel on NPM unless set to ignore via a skip-release Github label.

• PRs made into the default branch are deployed to the next pre-release tag on NPM. The result can be installed with npm install @nteract/data-explorer@next.
  • When merging into next, please use the create a merge commit strategy. If rebase is used, auto won't be able to detect which PR introduced a particular set of commits..
• To release a new stable on NPM (aka the latest tag), open a PR from next into stable using this compare link.
  • When merging from next into stable, please use the create a merge commit strategy.