forked from tangled.org/core
this repo has no description

docs: reword contributing guide and link hacking.md

anirudh.fi 744219c8 9bbb99d8

verified
Changed files
+18 -14
docs
+12 -9
docs/contributing.md
··· 4 4 5 5 We follow a commit style similar to the Go project. Please keep commits: 6 6 7 - * **atomic**: each commit should represent one logical change 7 + * **atomic**: each commit should represent one logical change 8 8 * **descriptive**: the commit message should clearly describe what the 9 9 change does and why it's needed 10 10 11 11 ### message format 12 12 13 - ``` 13 + ``` 14 14 <service/top-level directory>: <affected package/directory>: <short summary of change> 15 15 16 16 ··· 26 26 appview: state: fix token expiry check in middleware 27 27 28 28 The previous check did not account for clock drift, leading to premature 29 - token invalidation. 29 + token invalidation. 30 30 ``` 31 31 32 32 ``` 33 33 knotserver: git/service: improve error checking in upload-pack 34 34 ``` 35 35 36 + The affected package/directory can be truncated down to just the relevant dir 37 + should it be far too long. For example `pages/templates/repo/fragments` can 38 + simply be `repo/fragments`. 39 + 36 40 ### general notes 37 41 38 42 - PRs get merged "as-is" (fast-forward) -- like applying a patch-series ··· 52 56 Small fixes like typos, minor bugs, or trivial refactors can be 53 57 submitted directly as PRs. 54 58 55 - For larger changes—especially those introducing new features, 56 - significant refactoring, or altering system behavior—please open a 57 - proposal first. This helps us evaluate the scope, design, and potential 58 - impact before implementation. 59 + For larger changes—especially those introducing new features, significant 60 + refactoring, or altering system behavior—please open a proposal first. This 61 + helps us evaluate the scope, design, and potential impact before implementation. 59 62 60 63 ### proposal format 61 64 62 65 Create a new issue titled: 63 66 64 - ``` 65 - proposal: <affected scope>: <summary of change> 67 + ``` 68 + proposal: <affected scope>: <summary of change> 66 69 ``` 67 70 68 71 In the description, explain:
+6 -5
readme.md
··· 4 4 [Tangled](https://tangled.sh)&mdash;a code collaboration platform built 5 5 on the [AT Protocol](https://atproto.com). 6 6 7 - Read the introduction to Tangled [here](https://blog.tangled.sh/intro). 7 + Read the introduction to Tangled [here](https://blog.tangled.sh/intro). Join the 8 + [Discord](https://chat.tangled.sh) or IRC at [#tangled on 9 + libera.chat](https://web.libera.chat/#tangled). 8 10 9 11 ## docs 10 12 11 - * [knot hosting 12 - guide](https://tangled.sh/@tangled.sh/core/blob/master/docs/knot-hosting.md) 13 - * [contributing 14 - guide](https://tangled.sh/@tangled.sh/core/blob/master/docs/contributing.md)&mdash;**read this before opening a PR!** 13 + * [knot hosting guide](/docs/knot-hosting.md) 14 + * [contributing guide](/docs/contributing.md) **please read before opening a PR!** 15 + * [hacking on tangled](/docs/hacking.md) 15 16 16 17 ## security 17 18