Skip to content

Commit

Permalink
Merge 003bca5 into cb0097c
Browse files Browse the repository at this point in the history
  • Loading branch information
delan authored Feb 19, 2025
2 parents cb0097c + 003bca5 commit c70d34b
Show file tree
Hide file tree
Showing 4 changed files with 203 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ $ rm tools/runs.json # Optional: clear CI history cache
$ tools/list-commits-by-nightly.sh /path/to/servo
```

To copy the output to your clipboard for a specific calendar month only:

```sh
$ tools/list-commits-by-nightly.sh ~/code/servo 2>&1 | tee /dev/stderr | sed '/^>>> 2025-01-/,/^>>> 2025-02-/!d' | xclip -sel clip
```

## How to list this year’s pull request contributors

```sh
Expand Down Expand Up @@ -347,6 +353,17 @@ And generally we want to exclude...
- refactors (unless large-scale)
- dependency cleanups

The suggested workflow for efficiently triaging commits is as follows:

- [List commits that landed in each nightly](#how-to-list-commits-that-landed-in-each-nightly) last month, copying the output to your clipboard
- In your monthly update post, paste that output between a `<!--[commits]` line and a `[/commits]-->` line
- For each commit, click on the link to read more and understand its impact (see [§ Hints for writing about changes](#hints-for-writing-about-changes))
- For each commit to be excluded from the post, prefix the line with `-`
- For each commit to be included in the post, prefix the line with `+` then:
- Add a line immediately below of the form ` one or more tags` (four spaces, then space-separated tags)
- To write some notes or additional context, append `; your notes` to that new tags line
- Generate the outline: `tools/generate-outline.sh _posts/xxxx-xx-xx-this-month-in-servo.md`

## Hints for writing about changes

**Always check the correct names of people and API features.** People like it when their names are spelled correctly, of course, but sometimes authors refer to API features by incorrect names. When in doubt, check the spec. For example, [servo#32642](https://github.com/servo/servo/pull/32642) says “ShaderCompilationInfo” in the title, but the interface is actually [GPUCompilationInfo](https://developer.mozilla.org/en-US/docs/Web/API/GPUCompilationInfo), returned by the [getCompilationInfo() method on GPUShaderModule](https://developer.mozilla.org/en-US/docs/Web/API/GPUShaderModule/getCompilationInfo) ([July 2024](https://servo.org/blog/2024/07/31/this-month-in-servo/)).
Expand Down
Loading

0 comments on commit c70d34b

Please sign in to comment.