Skip to content

Latest commit

 

History

History
127 lines (86 loc) · 7.43 KB

CONTRIBUTING.md

File metadata and controls

127 lines (86 loc) · 7.43 KB
Raw

Contributing to Teku

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Welcome to the Teku repository! The following is a set of guidelines for contributing to this repo and its packages. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

Code of Conduct

I just have a quick question

How to contribute

Style Guides

Code of Conduct

This project and everyone participating in it is governed by the Teku Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to private-quorum@consensys.net.

I just have a quick question

You'll find us on Discord and that's the fastest way to get an answer.

How To Contribute

Your first code contribution

Start by looking through the 'good first issue' and 'help wanted' issues:

  • [Good First Issue][search-label-good-first-issue] - issues which should only require a few lines of code, and a test or two.
  • [Help wanted issues][search-label-help-wanted] - issues which are a bit more involved than good first issue issues.

Local Development

The codebase is maintained using the "contributor workflow" where everyone without exception contributes patch proposals using "pull-requests". This facilitates social contribution, easy testing and peer review.

To contribute a patch, the workflow is as follows:

  • Fork repository
  • Create topic branch
  • Commit patch
  • Create pull-request, adhering to the coding conventions herein set forth

In general a commit serves a single purpose and diffs should be easily comprehensible. For this reason do not mix any formatting fixes or code moves with actual code changes.

Architectural Best Practices

Questions on architectural best practices will be guided by the principles set forth in Effective Java by Joshua Bloch

Automated Test coverage

All code submissions must be accompanied by appropriate automated tests. The goal is to provide confidence in the code’s robustness, while avoiding redundant tests.

Pull Requests

The process described here has several goals:

  • Maintain Product quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible product
  • Enable a sustainable system for maintainers to review contributions
  • Further explanation on PR & commit messages can be found in this post: How to Write a Git Commit Message.

Please follow these steps to have your contribution considered by the approvers:

  1. Complete the CLA, as described in CLA.md
  2. Follow all instructions in PULL-REQUEST-TEMPLATE.md
  3. Include appropriate test coverage. Testing is 100% automated. There is no such thing as a manual test.
  4. Follow the Style Guides
  5. After you submit your pull request, verify that all status checks are passing
    What if the status checks are failing?If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted. Please refer to [Code Reviews].

Reporting Bugs

Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started Teku, e.g. which command exactly you used in the terminal, or how you started it otherwise.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots which show you following the described steps and clearly demonstrate the problem.

Provide more context by answering these questions:

  • Did the problem start happening recently (e.g. after updating to a new version of the software) or was this always a problem?
  • If the problem started happening recently, can you reproduce the problem in an older version of the software? What's the most recent version in which the problem doesn't happen?
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.

Include details about your configuration and environment:

  • Which version of the software are you using? You can get the exact version by running teku -v in your terminal.
  • What OS & Version are you running?
    • For Linux - What kernel are you running? You can get the exact version by running uname -a in your terminal.
  • Are you running in a virtual machine? If so, which VM software are you using and which operating systems and versions are used for the host and the guest?
  • Are you running in a docker container? If so, what version of docker?
  • Are you running in a Cloud? If so, which one, and what type/size of VM is it?
  • What version of Java are you running? You can get the exact version by looking at the Teku logfile during startup.

Style Guides

Java Code Style Guide

We use Google's Java coding conventions for the project. To reformat code, run:

./gradlew spotlessApply

Code style will be checked automatically during a build.

Coding Conventions

We have a set of coding conventions to which we try to adhere. These are not strictly enforced during the build, but should be adhered to and called out in code reviews.

Git Commit Messages & Pull Request Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Provide a summary on the first line with more details on additional lines as needed
  • Reference issues and pull requests liberally