Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (28 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

35 lines (28 loc) · 1.58 KB
Raw

Contributing

Human-written and AI-assisted contributions are both welcome, under the same rules. Open an issue or a pull request at https://github.com/porthole-dev/phosh-nfc-quick-setting.

Commits

  • Sign off every commit (git commit -s). Signed-off-by: is your Developer Certificate of Origin: it certifies that you have the right to submit the change. Only a person can give it, never an AI tool. CI rejects a pull request with a commit whose sign-off does not match its author.
  • Disclose AI assistance. If an AI tool helped write a change, add an Assisted-by: trailer naming the tool (for example Assisted-by: Claude) before your sign-off. A change written without one needs no trailer. See AI.md. Never list an AI tool as Co-authored-by: or in Signed-off-by:; CI rejects both, and tool boilerplate such as "Generated with ..." lines.
  • One logical change per commit, with a subject that says what changes and a body that says why.

Checks

There is no test suite: the thing under test is a shell plugin, so try a change in a running phosh. CI builds and installs the plugin (.github/workflows/ci.yml) and runs the organization's commit check (trailers and sign-off, porthole-dev/.github).

Releases

The version is in meson.build. To release, update it in one commit, then tag it v<version> on main and push the tag. GitHub serves the release tarball at https://github.com/porthole-dev/phosh-nfc-quick-setting/archive/refs/tags/v<version>.tar.gz, which is the source the postmarketOS package fetches.