Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

64 lines (43 loc) · 2.11 KB
Raw

Contributing to cfd

Patches and contributions to this project are welcome!!

Getting started

First you will need to setup your GitHub account and create a fork:

  1. Create a GitHub account
  2. Setup GitHub access via SSH
  3. Create your own fork of this repo
  4. Clone it to your machine

Testing

Ensure test pass correctly before create the pull request.

> go test ./... -cover -count=1

Building

Final artifacts are building by using Github Actions. If you want to compile the binary on your machine:

> cd cmd/cfd
> go build

Commit texts

To maintain a coherent set of messages please use this format on commit messages when possible.

<type>: <message> #<issue number>

Where type os one of these:

  • fix: When the commit fixes a bug.
  • feature: A new feature is added to the service. (Remember to update the documentation reflecting the changes).
  • docs: Adds documentation. (really welcome these kind of commits).
  • ci: Continous integration related commits.
  • test: When some tests are pushed alone.

On every release all commits will be added to the release notes automatically except those from docs, ci and test.

Creating a PR

When you have changes you would like to propose to cdf, you will need to:

  1. Ensure the commit message(s) describe what issue you are fixing and how you are fixing it (include references to issue numbers if appropriate)
  2. Create a pull request
  3. Please follow the guidelines on the pull request template.

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.