Skip to content

Latest commit

 

History

History
29 lines (21 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

29 lines (21 loc) · 1.41 KB
Raw

Contributing Guidelines

go-YouTokenToMe project is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on development workflow, commit message formatting, contact points, and other resources to make it easier to get your contribution accepted.

How to Contribute

Pull Requests (PRs) are the main and exclusive way to contribute to the official src-d/go-YouTokenToMe project. In order for a PR to be accepted it needs to pass a list of requirements:

  • All PRs must be written in idiomatic Go, formatted according to gofmt and goimports, and without any warnings from go lint nor go vet.
  • Python code must satisfy the coding conventions.
  • New features should be generally covered with tests.
  • The test suite must pass.
  • All PRs have to pass the personal evaluation of at least one of the maintainers.

Format of the commit message

The commit summary must start with a capital letter and with a verb in present tense. No dot in the end.

Add a feature
Remove unused code
Fix a bug

Every commit details should describe what was changed, under which context and, if applicable, the GitHub issue it relates to.