Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 1.24 KB

Contributing

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

Getting Started

  • Make sure you have a GitHub account
  • Submit a ticket for your issue, assuming one does not already exist.
  • Clearly describe the issue including steps to reproduce when it is a bug.
  • Make sure you fill in the earliest version that you know has the issue.

Making Changes

  • Fork the repository on GitHub.
  • Make the changes to your forked repository.
  • Ensure you stick to the Go formatting conventions (use go fmt).
  • Ensure you use UNIX-style LF line endings.
  • When committing, reference your issue (#1234) and include a note about the fix.
  • Push the changes to your fork and submit a pull request on the master repository.
  • At this point you're waiting on us to merge your pull request. We'll review all pull requests, and make suggestions and changes if necessary.

Pull Requests Checklist

Please check the following points before submitting your pull request:

[x] Code compiles correctly [x] Created tests, if possible [x] All tests pass [x] Extended the README / documentation, if necessary [x] Added yourself to the AUTHORS file, if not already there