Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 1.61 KB

Contributing Guidelines

Reporting Issues

Before creating a new Issue, please check first if a similar Issue already exists or was recently closed.

Gophers channel

Please provide the following minimum information:

  • Your VolantMQ version (or git SHA)
  • Your Go version (run go version in your console)
  • A detailed issue description
  • Error Log if present
  • If possible, a short example
  • Try reproduce issue with development build

Contributing Code

By contributing to this project, you share your code under the Apache License, Version 2.0, as specified in the LICENSE file.

Pull Requests Checklist

Please check the following points before submitting your pull request:

  • Install pre-commit in your local git copy pre-commit install
  • Code passes all of pre-commit hooks
  • Created tests, if possible
  • All tests pass
  • Extended the README / documentation, if necessary
  • Create with remote branch with in following pattern: issue-<issue_id> (e.g. issue-22)

Code Review

Everyone is invited to review and comment on pull requests. If it looks fine to you, comment with "LGTM" (Looks good to me).

If changes are required, notice the reviewers with "PTAL" (Please take another look) after committing the fixes.

Before merging the Pull Request, at least one team member must have commented with "LGTM".