How to Contribute

Glitter Protocl welcomes community contributions! We'd love to accept your patches and contributions to all our open git repos. Below are some guidelines that you need to follow.

Contributor License Agreement

A Contributor License Agreement must be included with contributions to any Glitter project. It will give Glitter Protocol permission to use and redistribute your contributions as part of the project; this is not a copyright transfer.

You must sign a personal CLA (CLA in progress; get in touch with us if you want to contribute right away) if you are an individual authoring original source code and you are certain that you are the rightful owner of the intellectual property.

You must sign a corporate CLA (CLA in progress; contact us if you wish to contribute now) if your employer wants to let you to donate your work.

If you've already filed a CLA (even if it was for a different project), you probably don't need to do it again since you only need to do it once.

Submitting a patch

Generally speaking, it's best to begin by creating a new issue that details the defect or feature you want to improve. Even if you believe it to be somewhat unimportant, it is useful to be aware of what others are working on. In order for the bug or feature to be assigned to you, mention in the first issue that you intend to work on it.

Use the standard procedure to fork the project, then create a new branch to work in. To guarantee that a pull request only contains the commits relating to that problem or feature, it is crucial that each group of changes be made in different branches.

Almost usually, any important changes should be followed by tests. If you're unclear of how to proceed, have a look at some of the project's existing tests since they already provide good test coverage.

For every change, try your best to have well-written commit statements. This assures consistency throughout the project and that different git tools can format commit messages correctly.

Finally, create a pull request after pushing the commits to your fork.