idestis/gort

View on GitHub
CONTRIBUTING.md

Summary

Maintainability
Test Coverage
# Contributing to Gort

The following is a set of guidelines for contributing to Gort. These are mostly guidelines, not rules. Use your best and feel free to propose changes using pull request or issues.

## Code of Conduct
---

### How Can I Contribute?

#### Reporting Bugs

For instance, you found a bug, please refer to [Issues](https://github.com/idestis/gort/issues) and open a new issue with label `bug`. Leave the detailed description of how we can reproduce it and resolve this issue.

**How Do I Submit A (Good) Bug Report?**

* **Use a clear and descriptive title** for the issue to identify the problem
* **Describe the exact steps which reproduce the problem** in as many details as possible.
* **Describe the behavior you observed after following the steps**
* **Explain which behavior you expected to see instead and why**

#### Suggesting Enhancements

Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/)

In case when your inner voice desire a new feature, please open an issue with `enhancement` label.

But please refer to short rules to open a good enhancement request

* **Use a clear and descriptive title** for the issue
* **Describe which behavior you expect** with this feature

#### Development

When you are good with Go, you can fork this repo and suggest changes via Pull Requests.