zan.dev
forked from
tangled.org/core
Monorepo for Tangled — https://tangled.org
docs/contributing.md: reword nested dirs & general notes
Signed-off-by: Anirudh Oppiliappan <anirudh@tangled.sh>
anirudh.fi
+7
-3
docs/contributing.md
+7
-3
docs/contributing.md
···
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
37
### general notes
41
38
···
43
40
using `git am`. At present, there is no squashing -- so please author
44
41
your commits as they would appear on `master`, following the above
45
42
guidelines.
43
+
- If there is a lot of nesting, for example "appview:
44
+
pages/templates/repo/fragments: ...", these can be truncated down to
45
+
just "appview: repo/fragments: ...". If the change affects a lot of
46
+
subdirectories, you may abbreviate to just the top-level names, e.g.
47
+
"appview: ..." or "knotserver: ...".
48
+
- Keep commits lowercased with no trailing period.
46
49
- Use the imperative mood in the summary line (e.g., "fix bug" not
47
50
"fixed bug" or "fixes bug").
48
51
- Try to keep the summary line under 72 characters, but we aren't too
49
52
fussed about this.
53
+
- Follow the same formatting for PR titles if filled manually.
50
54
- Don't include unrelated changes in the same commit.
51
55
- Avoid noisy commit messages like "wip" or "final fix"—rewrite history
52
56
before submitting if necessary.