Contributing

July 17, 2026 ยท View on GitHub

Want to contribute to Skyhook (NodeWright)? We welcome bug reports, feature requests, and pull requests.

Filing Issues

Claiming an Issue

Want to work on an issue? Claim it so others know it is taken. Comment on the issue and a bot will handle the assignment:

  • /assign: assign the issue to yourself (only if it is currently unassigned).
  • /assign @user: assign one other person (only if the issue is unassigned).
  • /unassign: release your claim on the issue.

We use a single-owner model: an issue is assigned to at most one person. /assign is refused while the issue already has an assignee, and /unassign only ever removes your own claim, so nobody can drop someone else's. GitHub only lets you assign the commenter/self, someone who has commented on the issue, a user with write access, or an org member with read access; if a requested user cannot be assigned, the bot replies to say so.

Pull Requests

  1. Fork the repository and create a branch from main.
  2. Make your changes and ensure tests pass (make test in the relevant component directory).
  3. Run make fmt to format code and add license headers.
  4. When you bump a Go or Python dependency, run make notices and commit the refreshed THIRD_PARTY_NOTICES.md files alongside your change. See docs/release-process.md for the workflow.
  5. Commit with a Conventional Commits message and sign off (see below).
  6. Open a pull request against main. The PR template will guide you through the checklist.

AI-Assisted Contributions Policy

We welcome the use of AI tools (e.g., Claude, GitHub Copilot, ChatGPT) to help you write code, brainstorm, or refactor. However, we maintain a strict human-in-the-loop policy for all submissions:

  • Full accountability: By submitting a PR, you (the human author) accept full responsibility for the code: its correctness, security, maintainability, and license compliance. "The AI wrote it" is not an acceptable explanation for bugs or security flaws.
  • Understand what you submit: Do not submit AI-generated code you do not fully understand. Reviewers expect you to explain and defend every line of code in your PR.
  • Follow the project rules: Coding assistants must follow the guidance in .claude/CLAUDE.md (symlinked as AGENTS.md), including running make fmt, make test, and keeping docs/ in sync.

Developer Certificate of Origin (DCO)

The sign-off is a simple line at the end of the explanation for the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify the below (from developercertificate.org):

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Then you just add a line to every git commit message:

Signed-off-by: Joe Smith <joe.smith@email.com>

Use your real name (sorry, no pseudonyms or anonymous contributions.)

If you set your user.name and user.email git configs, you can sign your commit automatically with git commit -s.

Code Style

We use Conventional Commits for our commit messages.

Python (Agent)

We use Black for Python code style. For testing, we use pytest.

Golang (Operator / CLI)

We use gofmt for Golang code style. For testing, we use Ginkgo and Gomega.

License Header

We use scripts/format_license.py to add the license header to the code.

make license-fmt

This adds the license header based on the LICENSE file and removes/replaces any existing header. Component Makefiles also run this automatically via make fmt.