Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

36 lines (24 loc) · 1.37 KB
Raw

Contributing Guidelines

Reporting Issues

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

Please provide the following minimum information:

  • Your SurgeMQ 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

Contributing Code

By contributing to this project, you share your code under the Apache License, Version 2.0, as specified in the LICENSE file. Don't forget to add yourself to the AUTHORS file.

Pull Requests Checklist

Please check the following points before submitting your pull request:

  • Code compiles correctly
  • Created tests, if possible
  • All tests pass
  • Extended the README / documentation, if necessary
  • Added yourself to the AUTHORS file

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".