Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 2.56 KB

Contributing.md

File metadata and controls

42 lines (26 loc) · 2.56 KB
Raw

Contributing

This project accepts contributions. In order to contribute, you should pay attention to a few guidelines:

Reporting Issues

Bugs, feature requests, and development-related questions should be directed to our GitHub issue tracker

When reporting a bug, please try and provide as much context as possible such as your operating system, Go version, and anything else that might be relevant to the bug. For feature requests, please explain what you're trying to do, and how the requested feature would help you do that.

Setup

Fork, then clone this repository:

$ git clone https://github.com/axiomhq/axiom-loki-multiplexer.git
$ cd axiom-loki-multiplexer
$ make

Submitting Modifications

  1. It's generally best to start by opening a new issue describing the bug or feature you're intending to fix. Even if you think it's relatively minor, it's helpful to know what people are working on. Mention in the initial issue that you are planning to work on that bug or feature so that it can be assigned to you.

  2. Follow the normal process of forking the project, and setup a new branch to work in. It's important that each group of changes be done in separate branches in order to ensure that a pull request only includes the commits related to that bug or feature.

  3. Go makes it very simple to ensure properly formatted code, so always run go fmt on your code before committing it. You should also Make sure that the tests and the linters pass by running:

$ make test 
$ make lint

  1. Do your best to have well-formated commit messages for each change. This provides consistency throughout the project, and ensures that commit messages are able to be formatted properly by various git tools.

  2. Finally, push the commits to your fork and submit a pull request

Once you've filed the PR:

  • One or more maintainers will use GitHub's review feature to review your PR.
  • If the maintainer asks for any changes, edit your changes, push, and ask for another review.
  • If the maintainer decides to suggest some improvements or alternatives, modify and make improvements. Once your changes are approved, one of the project maintainers will merge them.