Skip to content

Latest commit

 

History

History
40 lines (22 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

40 lines (22 loc) · 1.73 KB
Raw

Contributing to Shards

This document outlines the guidelines for contributing to the project.

Issues

The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests.

Bug Reports

A bug is a demonstrable problem that is caused by the code in the repository.

Guidelines for bug reports:

  1. Use the GitHub issue search and check if the issue has already been reported.

  2. Check if the issue has been fixed - try to reproduce it using the latest master or dev branch in the repository.

Feature Requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

Pull Requests

Code is always welcome, however, before submitting your code, please ensure that:

  1. Your code is clean, concise, and well-documented.

  2. You've run gofmt on your code.

  3. You submit your code to the dev branch. Any submissions to the master branch will be automatically closed. The master branch will hold major versions, while ongoing development will take place in the dev branch and collectively rolled out in periodic major releases.

NOTICE: By submitting a pull request, you agree to allow the project owners to license your work under the terms of the MIT License.