Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

49 lines (31 loc) · 1.92 KB
Raw

Legal

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 Apache 2.0 license (see LICENSE).

Submitting a Bug

Please ensure to specify the following:

  • swift-iavlplus commit hash
  • Simplest possible steps to reproduce
  • A pull request with a failing test case is preferred, but it's just as fine to write it in the issue description
  • Environment Information
  • For example, are you running in Docker? How are you connecting to it through Docker? What version of Docker?
  • OS version and output of uname -a
  • Swift version or output of swift --version

Development

Git Workflow

master is always the development branch.

For minor or patch SemVer changes, create a branch off of the tagged commit.

Environment Setup

It is highly recommended to use Docker to work with Tendermint locally.

docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint init

docker run -it --rm -v "/tmp:/tendermint" -p "26656-26657:26656-26657" tendermint/tendermint node --proxy_app="tcp://host.docker.internal:26658"

Otherwise, install Tendermint directly on your machine from Tendermint.com.

Submitting a Pull Request

A great PR that is likely to be merged quickly is:

  1. Concise, with as few changes as needed to achieve the end result.
  2. Tested, ensuring that regressions aren't introduced now or in the future.
  3. Documented, adding API documentation as needed to cover new functions and properties.
  4. Accompanied by a great commit message

Contributor Conduct

All contributors are expected to adhere to this project's Code of Conduct.