Tellor Docs
Search…
Contributing
Process of contributing to the project.
Thank you for considering to help. Contributions are very welcome and additionally incentivized through Gitcoin bounties. Ping us on the discord dev's channel to get started.

Philosophy

  • The philosophy is borrowing much from UNIX philosophy and the golang programming language.Each sub command should do one thing and do it well
    • Every component behavior should be covered with an e2e test and if an e2e test is not appropriate should at least have unit tests for key components of a package.

Feedback / Issues

If you encounter any issue or you have an idea to improve, please:
We are recommending, using GitHub issues for issues and feedback because GitHub issues are track-able and will help other people searcing for solutions or answers.
If you encounter a security vulnerability, please let us know privately via: [email protected]

Adding New Features / Components

For any major changes or new features, please first discuss the change you wish to make via issue or Discord, or any other method before making a change.

Development

The following section explains various suggestions and procedures to note during development.

First Steps

  • Familiarizing yourself with our coding style guidelines.
  • Familiarizing yourself with the Makefile commands, for example, build, format, test, lint.
    make help will print all available commands with some description.

Pull Request Process

  1. 1.
    Fork the repository and start development from your own fork. Here are sample steps to setup your development environment:
1
$ GOPATH=$(go env GOPATH)
2
$ mkdir -p $GOPATH/src/github.com/tellor-io
3
$ cd $GOPATH/src/github.com/tellor-io
4
$ git clone https://github.com/tellor-io/telliot.git
5
$ cd telliot
6
$ git remote add fork git remote add fork [email protected]/<your_github_id>/telliot.git
7
$ make build
8
$ ./telliot -h
Copied!
  1. 1.
    Keep PRs as small as possible. For each of your PRs, you create a new branch based on the latest master.
    Chain them if needed (base one PR on other PRs). You can read more details about the workflow from here.
1
$ git checkout master
2
$ git pull origin master
3
$ git checkout -b <your_PR_branch>
4
$ <Iterate your development>
5
$ git push fork <your_PR_branch>
Copied!
  1. 1.
    If your change affects users (adds,removes or changes a feature) add the item to the CHANGELOG.
  2. 2.
    Add e2e tests for new features and changes to functionality. Add unit tests for key components of the packages.
  3. 3.
    A PR will me merged once the PR has been approved by at least one developer with write access.
  4. 4.
    If you feel like your PR is waiting too long for a review, feel free to ping in the Discord channel for a review!

Dependency management

The project uses Go modules to manage dependencies on external packages. This requires a working Go environment with version 1.11 or greater and git installed.
To add or update a new dependency, use the go get command:
1
# Pick the latest tagged release.
2
go get example.com/some/module/pkg
3
4
# Pick a specific version.
5
go get example.com/some/module/[email protected]
Copied!
Tidy up the go.mod and go.sum files:
1
make deps
2
git add go.mod go.sum
3
git commit
Copied!

Project development go tools

The project uses Bingo for adding any go tools required by the project.
Last modified 4mo ago