Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 3.96 KB

CONTRIBUTING.md

File metadata and controls

64 lines (42 loc) · 3.96 KB
Raw

How to Contribute to Kelp

Please read the Contribution Guide below

Then please sign the Contributor License Agreement.

Contribution Guide

Your contributions to Kelp will help improve the Stellar network and the world’s financial infrastructure, faster.

We want to make it as easy as possible to contribute changes that help the project grow and thrive. There are a few guidelines that we ask contributors to follow so that we can merge your changes quickly.

Getting Started

  • Make sure you have a GitHub account.
  • Create a GitHub issue for your contribution, assuming one does not already exist.
    • Clearly describe the issue including steps to reproduce it (if it is a bug).
  • Fork the repository on GitHub and start working on your change.
  • When your change is ready then [submit a Pull Request].
  • Please sign the Contributor License Agreement so we can accept your contributions.

Minor Changes

For low-impact changes (ex: comments, documentation), it is not always necessary to create a new GitHub issue. In this case, it is appropriate to start the first line of a commit with 'doc' instead of an issue number.

Finding things to work on

The first place to start is always looking over the open GitHub issues for the project you are interested in contributing to. Issues marked with help wanted are usually pretty self-contained and a good place to get started.

Stellar Development Foundation (SDF) also uses these same GitHub issues to keep track of what we are working on. If you see any issues that are assigned to a particular person or have the in progress label, that means someone is currently working on that issue.

Of course, feel free to create a new issue if you think something needs to be added or fixed.

Making Changes

  • Create a feature branch in your fork from where you want to base your work.
    • It is most common to base branch on the master branch.
    • Please avoid working directly on the master branch.
  • Follow the code conventions of the existing repo. If you are adding a new file, please follow the Directory Structure in the README.
  • Make sure you have added the necessary tests for your changes and make sure all tests pass.
  • Run your code against the test network to ensure that everything works.
  • Update the README and walkthroughs if needed.

Submitting Changes

  • Sign the Contributor License Agreement so we can accept your contributions.
  • All content, comments, and pull requests must follow the Stellar Community Guidelines.
  • Push your changes to a feature branch in your fork of the repository.
  • Submit a Pull Request.
    • Include a descriptive commit message.
    • Include a link to your Github issue. Changes contributed via a pull request should focus on a single issue at a time.
    • Rebase your local changes against the master branch. Resolve any conflicts that arise.

At this point you're waiting on us. We like to at least comment on pull requests within three business days (typically, one business day). We may suggest some changes, improvements or alternatives.

Additional Resources

This document is inspired by: