lewis.moe
forked from
tangled.org/core
Monorepo for Tangled
docs: update contributing guide
PRs are no longer merged as a single commit.
anirudh.fi
+9
-7
docs/contributing.md
+9
-7
docs/contributing.md
···
11
11
### message format
12
12
13
13
```
14
-
<service/top-level directory>: <package/path>: <short summary of change>
14
+
<service/top-level directory>: <affected package/directory>: <short summary of change>
15
15
16
16
17
-
Optional longer description, if needed. Explain what the change does and
18
-
why, especially if not obvious. Reference relevant issues or PRs when
19
-
applicable. These can be links for now since we don't auto-link
20
-
issues/PRs yet.
17
+
Optional longer description can go here, if necessary. Explain what the
18
+
change does and why, especially if not obvious. Reference relevant
19
+
issues or PRs when applicable. These can be links for now since we don't
20
+
auto-link issues/PRs yet.
21
21
```
22
22
23
23
Here are some examples:
···
35
35
36
36
### general notes
37
37
38
-
- PRs get merged as a single commit, so keep PRs small and focused. Use
39
-
the above guidelines for the PR title and description.
38
+
- PRs get merged "as-is" (fast-forward) -- like applying a patch-series
39
+
using `git am`. At present, there is no squashing -- so please author
40
+
your commits as they would appear on `master`, following the above
41
+
guidelines.
40
42
- Use the imperative mood in the summary line (e.g., "fix bug" not
41
43
"fixed bug" or "fixes bug").
42
44
- Try to keep the summary line under 72 characters, but we aren't too