Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) · 1.73 KB
Raw

Contributing

First off, thanks for taking the time to contribute!

Remember that this is open source software so please consider the other people who will read your code. Make it look nice for them, document your logic in comments and add or update the unit test cases.

This library is used by various other projects, companies and individuals in live production environments so please discuss any breaking changes with us before making them. Feel free to join us in the #go-ping channel of the Gophers Slack.

Pull Requests

Fork the repo on GitHub and clone it to your local machine.

git clone https://github.com/YOUR_USERNAME/ping.git && cd ping

Here is a guide on how to configure a remote repository.

Check out a new branch, make changes, run tests, commit & sign-off, then push branch to your fork.

$ git checkout -b <BRANCH_NAME>
# edit files
$ make style vet test
$ git add <CHANGED_FILES>
$ git commit -s
$ git push <FORK> <BRANCH_NAME>

Open a new pull request in the main go-ping/ping repository. Please describe the purpose of your PR and remember link it to any related issues.

We may ask you to rebase your feature branch or squash the commits in order to keep the history clean.

Development Guides

  • Run make style vet test before committing your changes.
  • Document your logic in code comments.
  • Add tests for bug fixes and new features.
  • Use UNIX-style (LF) line endings.
  • End every file with a single blank line.
  • Use the UTF-8 character set.