Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

37 lines (22 loc) · 1.89 KB
Raw

We welcome contributions from the community. Please read the following guidelines carefully to maximize the chances of your PR being merged.

Communication

  • Before starting work on a major feature, please reach out to us via GitHub or Slack. We will make sure no one else is already working on it and ask you to open a GitHub issue.
  • Small patches and bug fixes don't need prior communication.

Coding style

Breaking change policy

Both API and implementation stability are important to Nighthawk. Since the API is consumed by clients beyond Nighthawk, breaking changes to that are prohibited.

Submitting a PR

  • Generally Nighthawk mirrors Envoy's policy with respect to PR submission policy.
  • Any PR that changes user-facing behavior must have associated documentation in docs as well as release notes.

PR review policy for maintainers

  • Generally Nighthawk mirrors Envoy's policy with respect to maintainer review policy.
  • See OWNERS.md for the current list of maintainers.
  • It is helpful if you apply the label waiting-for-review to any PRs that are ready to be reviewed by a maintainer.
    • Reviewers will change the label to waiting-for-changes when responding.

DCO: Sign your work

Commits need to be signed off. See here.

Triggering CI re-run without making changes

See here.