Contributing

Contributing

Simply follow the standard pull request workflow.

Fork and clone

First, fork the hoice repository in your browser. Then clone your fork with

git clone https://<user_id>@github.com/<user_id>/hoice
# ...
cd hoice

Upstream (optional)

If you so wish, set the original repo as the upstream:

git remote add upstream https://github.com/hopv/hoice

This lets you retrieve updates (without merging) from the original repo with

git fetch upstream

and merge the updates with

git merge upstream/master

Open a pull request

Before opening a pull request, make sure there are no clippy warnings and run rustfmt.

Once you have modified the code and want to propagate your modifications to the hoice repo, open a pull request from your fork's github page. If your changes are not mergeable, update your fork using the instructions from the Upstream section.

Make sure to document your contribution in the comment attached to the pull request.