Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (51 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

69 lines (51 loc) · 3.24 KB

Contributing guidelines

Contributing steps

  1. Submit an issue describing your proposed change.
  2. Discuss and wait for proposal to be accepted.
  3. Fork this repo, develop and test your code changes.
  4. Submit a pull request.

Conventions

Please read through below conventions before contributions.

PullRequest conventions

Code conventions

  • Go Code Review Comments
  • Effective Go
  • Know and avoid Go landmines
  • Commenting
    • Go's commenting conventions
    • If reviewers ask questions about why the code is the way it is, that's a sign that comments might be helpful.
  • Naming
    • Please consider package name when selecting an interface name, and avoid redundancy. For example, storage.Interface is better than storage.StorageInterface.
    • Do not use uppercase characters, underscores, or dashes in package names.
    • Please consider parent directory name when choosing a package name. For example, pkg/controllers/autoscaler/foo.go should say package autoscaler not package autoscalercontroller.
      • Unless there's a good reason, the package foo line should match the name of the directory in which the .go file exists.
      • Importers can use a different name if they need to disambiguate.
    • Locks should be called lock and should never be embedded (always lock sync.Mutex). When multiple locks are present, give each lock a distinct name following Go conventions: stateLock, mapLock etc.

Folder and file conventions

  • All filenames should be lowercase.
  • Go source files and directories use underscores, not dashes.
    • Package directories should generally avoid using separators as much as possible. When package names are multiple words, they usually should be in nested subdirectories.
  • Document directories and filenames should use dashes rather than underscores.
  • All source files should add a license at the beginning.

How to work locally

  1. Clones this repo
  2. Create the cluster minikube start --memory=8192 --cpus=4
  3. Deploy Apache Pulsar Standalone
  4. Open the minikube tunnel in another terminal minikube tunnel -c
  5. Apply operator's crds make install
  6. Executes go run . in order to run the operator locally rather than inside the cluster
  7. Run tests ~/go/bin/ginkgo ./operator