Skip to main content

Contributor Guide

Getting Started#

  • Like, star and fork the repo if you want to help with visibility.
  • Read all of the documentation in this section!
  • Before starting any work, please introduce yourself on the Giveth Discord in the #Contribute channel (see chat links here: https://giveth.io/join)
  • If you found the project via a Gitcoin bounty, please make sure to check the issue every few days until completion (Gitcoin requires some proof of life checks).
  • Please start a new branch on your fork named with the feature/fix you want to attempt and make a pull request when you are confident everything is ready to publish.

Zenhub#

We use Zenhub, which you can install from here.

The use of columns in Zenhub in giveth-2:

New Issues - New bugs and features go here first.

Epics - Pipeline for Epic Issues. Larger tasks comprised of several smaller issues.

Icebox - Features or Suggestions that have been archived. Issues here are non-priority and might be added into sprints only if Devs have the bandwidth.

Backlog - Lower Priority Issues waiting to get pulled into Sprint Planning.

Sprint Backlog - These issues have been vetted and are ready to be worked on. They will be added into the next sprint according to priority and Developer bandwidth.

In Progress - Picked up and being worked on by the Developers, usually on local builds.

On Develop - Local changes have been pushed to the developer build for developers to test.

Staging (User testing) - The feature or bug fix is deployed on the staging server for user testing.

Done - Bug fixes or feature has been completed, and is ready to be deployed on the live server.

Closed - The bug fix or feature has been copied live

Please follow these guidelines, when working with Github issues

Github Issue Management#

Epics are for breaking up larger issues into smaller, more manageable issues.

Sprints are broken down into 2 weeks each. Developers are expected to finish their assigned tasks for the end each sprint. Before the beginning of each new sprint progress is assessed and Developers are assigned new issues brought in from the backlog for the upcoming sprint.

Creating Issues#

When you create an issue it's important to assign it to a developer so it get's acknowledged and properly prioritized. If you're not sure who to tag, reach out in discord.

Labels will help add context to your issue, please use them so contributors can get a better understanding of issues at a glance and pick them up.

The new issue template is a guide only, feel free to delete any heading that you don't use.

Last updated on by divine-comedian