How to contribute

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Check out the Stellar Contribution Guide that apply to all Stellar projects.

Style guides

Git Commit Messages

• Use the present tense ("Add feature" not "Added feature")
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...")

Issues

• Label issues with bug if they're clearly a bug.
• Label issues with feature request if they're a feature request.

Pull Requests

• PR titles follow the same rules as described in the Issues section above.
• PRs must update the CHANGELOG with a small description of the change
• PRs are merged into master or release branch using squash merge
• Carefully think about where your PR fits according to semver. Target it at master if it’s only a patch change, otherwise if it contains breaking change or significant feature additions, set the base branch to the next major or minor release.
• Keep PR scope narrow. Expectation: 20 minutes to review max
• Explicitly differentiate refactoring PRs and feature PRs. Refactoring PRs don’t change functionality. They usually touch a lot more code, and are reviewed in less detail. Avoid refactoring in feature PRs.

Go Style Guide

• Use gofmt or preferably goimports to format code
• Follow Effective Go and Go Code Review Comments

Go Coding conventions

• Always document exported package elements: vars, consts, funcs, types, etc.
• Tests are better than no tests.