Monorepo for Tangled forked from tangled.org/core
tangled-core docs contributing.md
4.0 kB · 137 lines
Markdown
at commit e47737da

# tangled contributing guide ## commit guidelines We follow a commit style similar to the Go project. Please keep commits: * **atomic**: each commit should represent one logical change * **descriptive**: the commit message should clearly describe what the change does and why it's needed ### message format ``` <service/top-level directory>: <affected package/directory>: <short summary of change> Optional longer description can go here, if necessary. Explain what the change does and why, especially if not obvious. Reference relevant issues or PRs when applicable. These can be links for now since we don't auto-link issues/PRs yet. ``` Here are some examples: ``` appview: state: fix token expiry check in middleware The previous check did not account for clock drift, leading to premature token invalidation. ``` ``` knotserver: git/service: improve error checking in upload-pack ``` ### general notes - PRs get merged "as-is" (fast-forward) -- like applying a patch-series using `git am`. At present, there is no squashing -- so please author your commits as they would appear on `master`, following the above guidelines. - If there is a lot of nesting, for example "appview: pages/templates/repo/fragments: ...", these can be truncated down to just "appview: repo/fragments: ...". If the change affects a lot of subdirectories, you may abbreviate to just the top-level names, e.g. "appview: ..." or "knotserver: ...". - Keep commits lowercased with no trailing period. - Use the imperative mood in the summary line (e.g., "fix bug" not "fixed bug" or "fixes bug"). - Try to keep the summary line under 72 characters, but we aren't too fussed about this. - Follow the same formatting for PR titles if filled manually. - Don't include unrelated changes in the same commit. - Avoid noisy commit messages like "wip" or "final fix"—rewrite history before submitting if necessary. ## proposals for bigger changes Small fixes like typos, minor bugs, or trivial refactors can be submitted directly as PRs. For larger changes—especia…