Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

51 lines (38 loc) · 2.25 KB
Raw

Contributing to LFS Test Server

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to this project are released to the public under the project's open source license.

Submitting a pull request

  1. Fork and clone the repository
  2. Configure and install the dependencies: go build
  3. Make sure the tests pass on your machine: go test
  4. Create a new branch: git checkout -b my-branch-name
  5. Make your change, add tests, and make sure the tests still pass
  6. Push to your fork and submit a pull request
  7. Pat your self on the back and wait for your pull request to be reviewed.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Follow the style guide where possible.
  • Write tests.
  • Update documentation as necessary.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Updating management templates

  1. Install go.rice with go install github.com/GeertJohan/go.rice
  2. Run rice embed-go after all template changes have been made
  3. Commit the change
  4. Submit a pull request.

Updating 3rd party packages

  1. Run godep save to add new dependencies.
  2. Run godep update foo/bar to update the package foo/bar.
  3. Commit the change. lfs-test-server vendors the full source code in the repository.
  4. Submit a pull request.

Resources

GoDoc