Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 875 Bytes

CONTRIBUTING.md

File metadata and controls

35 lines (21 loc) · 875 Bytes
Raw

Contributing to HTTP Broadcast

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to HTTP Broadcast project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Install and run the project locally

Clone the project:

$ git clone https://github.com/jderusse/http-broadcast
$ cd http-broadcast

Run the application:

$ go run .

To run the test suite:

$ go test ./... -race

To lint your code:

$ # GO111MODULE=off go get -u github.com/golangci/golangci-lint/cmd/golangci-lint
$ golangci-lint run --fix  ./...

Pull Request Process

Before submitting a Pull Request, make sure that:

  • Tests are green - including lint.
  • You add valid test cases.
  • You document the new behaviors