CONTRIBUTING.md

Contributing

Welcome ! and many thanks for taking the time to contribute !

First, you should have a look at the Technical design documentation to get an understanding of the design behind this project.

From there, there are a few options depending of which kind of contributions you have in mind: bug fix, documentation improvement, translation, testing, ...

Please note we have a code of conduct, please follow it in all your interactions with the project.

Build the project locally

The following commands should get you started:

Setup an alias:

alias broth='npx baldrick-broth'

or if you prefer to always use the latest version:

alias broth='npx baldrick-broth@latest'

Install the npm dependencies:

yarn install

Run the zest unit tests:

broth test spec

Run the pest CLI integration tests:

broth test pest

A list of most used commands is available:

broth

Please keep an eye on test coverage, bundle size and documentation. When you are ready for a pull request:

broth release ready

You will probably want to update the documentation:

broth doc ts

You can also simulate Github actions locally with act. You will need to setup .actrc with the node.js docker image -P ubuntu-latest=node:16-buster

To run the pipeline:

broth github act

Pull Request Process

1. Make sure that an issue describing the intended code change exists and that this issue has been accepted.

When you are about to do a pull-request:

broth release ready -pr

Then you can create the pull-request:

broth release pr

Publishing the library

This would be done by the main maintainers of the project. Locally for now as updates are pretty infrequent, and some of tests have to be done manually.

broth release publish