Skip to content

developers.md

Latest commit

 

History

History
93 lines (73 loc) · 3.71 KB

developers.md

File metadata and controls

93 lines (73 loc) · 3.71 KB
Raw

Developers

Contributing

Issues and Pull Requests (PR) are always welcome from anyone.

Coding

  • Wrap lines at 80 columns (or try hard)
  • gofmt all go files
  • If it feels like it's taking too long to code something, or the code you're writing feels more complex/harder than it should be, stop and ask the team about it. There may be a simple way to do what you're trying to do and it's better to ask a question than to waste your time rat-holing. Use the #xregistry CNCF slack channel appropriately.

Testing

  • To run a subset of tests use: TEST=xxx make qtest where "xxx" is a regular expression for the test name. For example, TEST=TestXR make qtest will run just the tests that start with TestXR. Try to keep name all of the tests in a test_xxx.go file with the same prefix so you can easily run all tests in that file by specifying their prefix.

  • Tests should check the expected output byte-for-byte. We want to make sure that every character (even spaces) are exactly as we expect. So, avoid expected outputs of "*" and regular expressions (ie. ones that start with ^).

  • There may be times when that rule is too strict due to output varying too much across runs/environments - try to use masking first, but as a last resort regexp matching of the output is ok.

    • The tooling utils (e.g. XHTTP) should mask most of the fields already by default (e.g. timestamps, error's source field).

  • If there are coding rules (or checks) that we want to enforce, and they're automatable, add those checks to cmds/xr/xrlint.

Pull Requests

Simple guidelines for PRs:

  • All PRs MUST be DCO signed to be accepted.
  • All PRs MUST successfully pass the make clean pr process.
  • PRs do not need an associated issue, stand-alone PRs are fine.
  • However, larger PRs would benefit from a discussion prior to doing the work.

READ THE SPECS!

Make sure you understand the xRegistry specifications. Some semantics are not obvious, and the docs should help explain why some decisions were made.

Build Locally

Most common Makefile targets:

# Build, test and run; will reset the DB & sample Registries:
make

# Build and run w/o testing; will reset the DB & sample Registries:
make run

# Build and run without testing or rebuilding DB & sample Registries:
make start

See misc/Dockefile-dev for the minimal dependencies required: golang and the packages listed on the RUN apk add command.

Makefile Targets

Target Description
make Defaults to make all
make clean Erase all build outputs, clean docker
make all Build all, run test and start server (reset DB)
make run Build and start server (no tests, reset DB)
make start Build and start server (no tests, keep DB)
make test Build all & run all tests
make qtest Build all & run just main tests
make benchmark Run some basic speed benchmarks (ftest/largeload)
make xr Build xr CLI only
make xrserver Build xrserver executable only
make cmds Build all executables (xrserver and xr)
make images Build all container images
make push Build all container images & push images to registry
make mysql Start MySQL in a container
make mysql-client Run the MySQL client in a container, for debugging
make testdev Build/verify dev image; make all using image