Skip to content

Latest commit

 

History

History
61 lines (35 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

61 lines (35 loc) · 2 KB

Contribution Guide

Welcome to the contribution guide for the go-kraken repository! We appreciate your interest in contributing to our project.

Prerequisites

Before you get started, make sure you have the following prerequisites:

  • Git installed on your local machine.
  • A GitHub account.
  • Familiarity with the Go programming language.

How to Contribute

Follow these steps to contribute to our project:

  1. Fork the Repository: Click the "Fork" button on the top right corner of this repository's page to create your own copy.

  2. Clone Your Fork: Clone your forked repository to your local machine:

`git clone https://github.com/jferrl/go-kraken.git` 
  1. Make Changes: Make your desired changes to the code or documentation.

  2. Test: If applicable, ensure that your changes pass any existing tests or add new tests if necessary.

  3. Commit and Push: Commit your changes and push them to your forked repository:

git add .
git commit -m "Descriptive commit message"
git push origin feature-or-fix-name
  1. Create a Pull Request (PR): Go to the original repository on GitHub and click the "New Pull Request" button. Describe your changes in the PR, follow any guidelines, and submit it for review.

Coding Guidelines

Uber Go Style Guide

Go Style Guide

Review Process

All contributions will be reviewed by the maintainer. We appreciate your patience during this process.

Code of Conduct

Please review our Code of Conduct before contributing. We want all contributors to follow our guidelines for a respectful and inclusive community.

License

By contributing to this project, you agree that your contributions will be licensed under the project's license.

Contact Us

If you have any questions or need assistance, feel free to reach out to us here.

Thank you for contributing to go-kraken!