You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+35Lines changed: 35 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,6 +36,41 @@ Members of the `rerun-io` organization and collaborators in the `rerun-io/rerun`
36
36
37
37

38
38
39
+
40
+
### Labeling of PRs & changelog generation
41
+
42
+
Members of the `rerun-io` organization _have_ to add label PRs since they're part of how we generate [changelogs](https://github.com/rerun-io/rerun/blob/main/CHANGELOG.md).
43
+
44
+
If `include in changelog` is present, the **title** of the PR will be used as a line in the detailed section of the changelog.
45
+
Therefore, make sure that it's informative & concise without any additional context other than the category.
46
+
If a PR title should not be part of the changelog, you _have_ to label the PR with `exclude from changelog`.
47
+
48
+
The category of the changelog entry is governed by additional labels of which you have to provide at least one.
49
+
The exact list may change over time, see the [CI job](./.github/workflows/labels.yml) checking for it for a full list.
50
+
51
+
Beyond changelog categorization, it's encouraged to add too many rather than too few labels as they help with search.
52
+
53
+
#### What should go to the changelog?
54
+
55
+
Whether a PR should be added to the changelog isn't always clear cut, but it's advised to err on the side of
56
+
adding too many entries rather than too few!
57
+
Generally, whenever you believe that this is a value-add for a user browsing the detailed changelog, add it.
58
+
Also, credit where credit is due, be more generous adding contributions from outside the `rerun-io` org to the changelog!
59
+
60
+
We typically don't include:
61
+
pure refactors, testing, CI fixes, fixes for bugs that showed up since the last release, minor doc changes (like typos) etc.
62
+
63
+
#### Other special labels
64
+
65
+
*`deploy docs`:
66
+
PRs marked with this will automatically be cherry-picked to the `docs-latest` branch which then will kick off a rebuild of the public [doc page](https://www.rerun.io/docs)
67
+
Use this for landing doc fixes that are relevant to the latest release.
68
+
*`do-not-merge`:
69
+
Will fail the CI unconditionally.
70
+
Useful e.g. for opening PRs that target branches other than `main` which you want to rebase prior to merging
71
+
or when you're still waiting on a test result.
72
+
Alternatively, you can also use checkboxes in the PR description - any unticked checkboxes will make the ci fail automatically ✨
73
+
39
74
## Contributing to CI
40
75
41
76
Every CI job would in its ideal state consist of only a single `pixi` (or similar) script invocation that works locally as-is.
0 commit comments