diff --git a/docs/contributing.md b/docs/contributing.md index c226ddfe..39330308 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -4,13 +4,13 @@ We follow a commit style similar to the Go project. Please keep commits: -* **atomic**: each commit should represent one logical change +* **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 -``` +``` : : @@ -26,13 +26,17 @@ 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. +token invalidation. ``` ``` knotserver: git/service: improve error checking in upload-pack ``` +The affected package/directory can be truncated down to just the relevant dir +should it be far too long. For example `pages/templates/repo/fragments` can +simply be `repo/fragments`. + ### general notes - PRs get merged "as-is" (fast-forward) -- like applying a patch-series @@ -52,17 +56,16 @@ before submitting if necessary. Small fixes like typos, minor bugs, or trivial refactors can be submitted directly as PRs. -For larger changes—especially those introducing new features, -significant refactoring, or altering system behavior—please open a -proposal first. This helps us evaluate the scope, design, and potential -impact before implementation. +For larger changes—especially those introducing new features, significant +refactoring, or altering system behavior—please open a proposal first. This +helps us evaluate the scope, design, and potential impact before implementation. ### proposal format Create a new issue titled: -``` -proposal: : +``` +proposal: : ``` In the description, explain: diff --git a/readme.md b/readme.md index 48a73291..a8062722 100644 --- a/readme.md +++ b/readme.md @@ -4,14 +4,15 @@ Hello Tanglers! This is the codebase for [Tangled](https://tangled.sh)—a code collaboration platform built on the [AT Protocol](https://atproto.com). -Read the introduction to Tangled [here](https://blog.tangled.sh/intro). +Read the introduction to Tangled [here](https://blog.tangled.sh/intro). Join the +[Discord](https://chat.tangled.sh) or IRC at [#tangled on +libera.chat](https://web.libera.chat/#tangled). ## docs -* [knot hosting -guide](https://tangled.sh/@tangled.sh/core/blob/master/docs/knot-hosting.md) -* [contributing -guide](https://tangled.sh/@tangled.sh/core/blob/master/docs/contributing.md)—**read this before opening a PR!** +* [knot hosting guide](/docs/knot-hosting.md) +* [contributing guide](/docs/contributing.md) **please read before opening a PR!** +* [hacking on tangled](/docs/hacking.md) ## security