Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
108 lines (81 loc) · 4.28 KB

CONTRIBUTING.md

File metadata and controls

108 lines (81 loc) · 4.28 KB

Contributors Guide

Vibehouse is an open-source Ethereum consensus client. We're community driven and welcome all contributions. We aim to provide a constructive, respectful and fun environment for collaboration.

This guide is geared towards beginners. If you're an open-source veteran feel free to just skim this document and get straight into crushing issues.

Why Contribute

There are many reasons you might contribute to vibehouse. For example, you may wish to:

  • contribute to the Ethereum ecosystem.
  • establish yourself as a layer-1 Ethereum developer.
  • work in the amazing Rust programming language.
  • learn how to participate in open-source projects.
  • expand your software development skills.
  • flex your skills in a public forum to expand your career opportunities (or simply for the fun of it).
  • grow your network by working with core Ethereum developers.

How to Contribute

We operate like a typical open-source project on GitHub: the repository Issues is where we track what needs to be done and Pull Requests is where code gets reviewed.

General Work-Flow

We recommend the following work-flow for contributors:

  1. Find an issue to work on, either because it's interesting or suitable to your skill-set. Use comments to communicate your intentions and ask questions.
  2. Work in a feature branch of your personal fork (github.com/YOUR_NAME/vibehouse) of the main repository (github.com/dapplion/vibehouse).
  3. Once you feel you have addressed the issue, create a pull-request with main as the base branch to merge your changes into the main repository.
  4. Wait for the repository maintainers to review your changes to ensure the issue is addressed satisfactorily.
  5. If the issue is addressed the repository maintainers will merge your pull-request and you'll be an official contributor!

First-time Set-up

First time contributors can get their git environment up and running with these steps:

  1. Create a fork and clone it to your local machine.
  2. Create a new feature branch with $ git checkout -b your_feature_name. The name of your branch isn't critical but it should be short and instructive. E.g., if you're fixing a bug with serialization, you could name your branch fix_serialization_bug.
  3. Make sure you sign your commits. See relevant doc.
  4. Commit your changes and push them to your fork with $ git push origin your_feature_name.
  5. Go to your fork on github.com and use the web interface to create a pull request into the dapplion/vibehouse repository.

From there, the repository maintainers will review the PR and either accept it or provide some constructive feedback.

There's a great guide by Rob Allen that provides much more detail on each of these steps, if you're having trouble.

FAQs

I don't think I have anything to add

There's lots to be done and there's all sorts of tasks. You can do anything from enhancing documentation through to writing core consensus code. If you reach out, we'll include you.

Please note, to maintain project quality, we may not accept PRs for small typos or changes with minimal impact.

I'm not sure my Rust is good enough

We're open to developers of all levels. If you create a PR and your code doesn't meet our standards, we'll help you fix it and we'll share the reasoning with you. Contributing to open-source is a great way to learn.

I'm not sure I know enough about Ethereum

No problems, there's plenty of tasks that don't require extensive Ethereum knowledge. You can learn about Ethereum as you go.

I'm afraid of making a mistake and looking silly

Don't be. We're all about personal development and constructive feedback. If you make a mistake and learn from it, everyone wins.

I don't like the way you do things

Please, make an issue and explain why. We're open to constructive criticism and will happily change our ways.