CONTRIBUTING.md

Contributing to bee

The project is hosted on GitHub where you can report issues, fork the project and submit pull requests.

Setup bee on your machine

Fork the repository on GitHub and clone your forked repository to your machine

git clone https://github.com/<username>/bee.git

If you want to contribute please consider to set up git-flow. The default branch of this repository is main

cd bee
git branch main origin/main
git flow init -d

Make changes

Create a new issue to let people know what you're working on and to encourage a discussion. Follow the git-flow conventions and create a new feature branch starting with # and the issue number:

git flow feature start <#123-your-feature>

Coding Style

Please follow the Shell Style Guide https://google.github.io/styleguide/shell.xml

Run tests

bee is written using bats-core for TDD and shellcheck for peace of mind. In order to run the test you need to update all submodules.

git submodule update --init --recursive

You can run all tests on your machine or in a docker container

test/run

test/run --docker

Run specific tests using bats directly

test/bats/bin/bats test/bee.bats

Build a docker container

You can build a bee docker container

DOCKER_BUILDKIT=1 docker build --build-arg BASH_VERSION=5.1 --target bee -t sschmid/bee .

docker run --rm -it -v "$(pwd)":/root/project sschmid/bee bash

Contribute

If you have many commits please consider using git rebase to cleanup the commits. This can simplify reviewing the pull request. Once you're happy with your changes create a pull request from your feature branch. The default branch is main.

---

By submitting a pull request, you represent that you have the right to license your contribution to the community, and agree by submitting the patch that your contributions are licensed under the bee license.

Thanks for your contributions and happy coding :)

Simon