Skip to content

Latest commit

 

History

History
70 lines (43 loc) · 3.28 KB

CONTRIBUTING.md

File metadata and controls

70 lines (43 loc) · 3.28 KB
Raw

Contributing Guidelines

The following is a set of guidelines for contributing to the NGINX AWS Auto-Scale Group Sync tool. We really appreciate that you are considering contributing!

Table Of Contents

Ask a Question

Getting Started

Contributing

Style Guides

Code of Conduct

Ask a Question

We will have a public forum soon where you can come and ask questions and have a discussion. For now please open an Issue on GitHub with the label question.

Getting Started

Read the installation, configuration and building steps in the README.

Project Structure

  • nginx-asg-sync is a service written in Go that works with NGINX Plus.
  • The main code is found under /cmd/sync/
  • Tools for building the service for supported Operating Systems are found under /build/package
  • The project dependencies reside in the /vendor. We use dep for managing dependencies.
  • There is a Makefile at the project root used in the build steps.

Contributing

Report a Bug

To report a bug, open an issue on GitHub with the label bug using the available bug report issue template. Please ensure the issue has not already been reported.

Suggest an Enhancement

To suggest an enhancement, please create an issue on GitHub with the label enhancement using the available feature issue template.

Open a Pull Request

  • Fork the repo, create a branch, submit a PR when your changes are tested and ready for review
  • Fill in our pull request template

Note: if you’d like to implement a new feature, please consider creating a feature request issue first to start a discussion about the feature.

Style Guides

Git Style Guide

  • Keep a clean, concise and meaningful git commit history on your branch, rebasing locally and squashing before submitting a PR
  • Follow the guidelines of writing a good commit message as described here https://chris.beams.io/posts/git-commit/ and summarised in the next few points
    • In the subject line, use the present tense ("Add feature" not "Added feature")
    • In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...")
    • Limit the subject line to 72 characters or less
    • Reference issues and pull requests liberally after the subject line
    • Add more detailed description in the body of the git message (git commit -a to give you more space and time in your text editor to write a good message instead of git commit -am)

Go Style Guide

  • Run gofmt over your code to automatically resolve a lot of style issues. Most editors support this running automatically when saving a code file.
  • Run go lint and go vet on your code too to catch any other issues.
  • Follow this guide on some good practice and idioms for Go - https://github.com/golang/go/wiki/CodeReviewComments
  • To check for extra issues, install golangci-lint and run make lint or golangci-lint run