Contributor Guide
Last updated
Was this helpful?
Last updated
Was this helpful?
We would love for you to contribute to cheqd and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow.
Help us keep cheqd open and inclusive. Please read and follow our
You can get help for any questions or problems that you have on through the following channels:
Check if your question/problem is already covered under our documentation sites:
(basics for general audience)
Raise a bug report or feature request using the "Issue" tab on Github
Ask the question on our or
For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
Before you submit an issue, please search the issue tracker. An issue for your problem might already exist and the discussion might inform you of workarounds readily available.
We want to fix all the issues as soon as possible, but before fixing a bug, we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions.
A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.
We require a minimal reproduction to save maintainers' time and ultimately be able to fix more bugs. Often, developers find coding problems themselves while preparing a minimal reproduction. We understand that sometimes it might be hard to extract essential bits of code from a larger codebase but we really need to isolate the problem before we can fix it.
Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you, we are going to close an issue that doesn't have enough info to be reproduced.
Before you submit your Pull Request (PR) consider the following guidelines:
Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work.
In your forked repository, make your changes in a new git branch:
Create your patch, including appropriate test cases.
Check that all workflow actions for linting / build / test pass.
Push your branch to GitHub:
In GitHub, send a pull request to cheqd-node:develop. The develop branch is where all pending PRs should be targetted for inclusion in the next release.
If you find a bug in the source code, you can help us by to our . Even better, you can with a fix.
You can request a new feature by to our GitHub Repository. If you would like to implement a new feature, please consider the size of the change in order to determine the right steps to proceed:
Small Features can be crafted and directly .
You can file new issues by selecting from our and filling out the issue template.
Search for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts.
the repository.
Commit your changes using a descriptive commit message that follows