Skip to content
This repository was archived by the owner on Apr 21, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (40 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

63 lines (40 loc) · 1.52 KB
Raw

Contributing

By participating to this project, you agree to abide our code of conduct.

Setup your machine

staticsync is written in Go.

Prerequisites:

Clone staticsync from source:

$ git clone git@github.com:cueblox/staticsync.git
$ cd staticsync

Install the build and lint dependencies:

$ go get

Test your change

You can create a branch for your changes and try to build from the source as you go:

$ go build

Create a commit

Commit messages should be well formatted. Start your commit message with the type. Choose one of the following: feat, fix, docs, style, refactor, perf, test, chore, revert, add, remove, move, bump, update, release

After a colon, you should give the message a title, starting with uppercase and ending without a dot. Keep the width of the text at 72 chars. The title must be followed with a newline, then a more detailed description.

Please reference any GitHub issues on the last line of the commit message (e.g. See #123, Closes #123, Fixes #123).

An example:

docs: Add example for --release-notes flag

I added an example to the docs of the `--release-notes` flag to make
the usage more clear.  The example is an realistic use case and might
help others to generate their own changelog.

See #284

Submit a pull request

Push your branch to your staticsync fork and open a pull request against the master branch.