Skip to content

chore: remove plugin checklist from PR template #7105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
watson merged 12 commits into from
Jan 23, 2026
Merged

chore: remove plugin checklist from PR template #7105

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
248575b
remove plugin checklist from PR template
simon-id Dec 15, 2025
73389dc
add warning about tests
simon-id Dec 16, 2025
a8f7cc0
move the checklist to CONTRIBUTING.md
simon-id Dec 16, 2025
f57420b
Merge branch 'master' into simon-id-patch-3
simon-id Dec 16, 2025
4bc6b4a
Merge branch 'master' into simon-id-patch-3
simon-id Dec 17, 2025
914868d
Update PR checklist section title
simon-id Dec 17, 2025
2dac666
Merge branch 'master' into simon-id-patch-3
simon-id Jan 4, 2026
b4e44e0
Update pull_request_template.md
simon-id Jan 20, 2026
dd687c7
Update pull_request_template.md
simon-id Jan 20, 2026
5da63dc
Merge branch 'master' into simon-id-patch-3
simon-id Jan 20, 2026
5d21757
remove pr checklist
simon-id Jan 22, 2026
45f61a5
Merge branch 'master' into simon-id-patch-3
watson Jan 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 2 additions & 20 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,8 @@
<ins>**Please make sure your changes are properly tested**!</ins>
Comment thread
watson marked this conversation as resolved.

### What does this PR do?
<!-- A brief description of the change being made with this pull request. -->

### Motivation
<!-- What inspired you to submit this pull request? -->

### Plugin Checklist
<!-- Fill this section if adding or updating a plugin. Remove otherwise. -->

- [ ] Unit tests.
- [ ] Integration tests.
- [ ] Benchmarks.
- [ ] TypeScript [definitions][1].
- [ ] TypeScript [tests][2].
- [ ] API [documentation][3].
- [ ] CI [jobs/workflows][4].

[1]: https://github.com/DataDog/dd-trace-js/blob/master/index.d.ts
[2]: https://github.com/DataDog/dd-trace-js/blob/master/docs/test.ts
[3]: https://github.com/DataDog/documentation/blob/master/content/en/tracing/trace_collection/library_config/nodejs.md
[4]: https://github.com/DataDog/dd-trace-js/blob/master/.github/workflows/plugins.yml

### Additional Notes
<!-- Anything else we should know when reviewing? -->
Comment thread
simon-id marked this conversation as resolved.


16 changes: 16 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -464,4 +464,20 @@ most efficient algorithm. To run your benchmark, use:
$ yarn bench
```

### PR Checklist

Here is a simple checklist to help write a more complete PR:
- [ ] Unit tests.
- [ ] Integration tests.
- [ ] Benchmarks.
- [ ] TypeScript [definitions][2].
- [ ] TypeScript [tests][3].
- [ ] API [documentation][4].
- [ ] CI [jobs/workflows][5].

@watson watson Dec 16, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the [ ]? This is no longer an issue/PR

@simon-id simon-id Dec 17, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so people that want to use the checklist can copy paste it in their description or somewhere else ;)

@watson watson Dec 17, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's meant to be copied it should be a code block, otherwise it's not possible. In its current state, it just shows disabled checkboxes that can't be checked

@simon-id simon-id Dec 17, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a compromise between making it look good in markdown, and making the original copyable. Either you're reading the markdown in an editor and the original copyable is there, or you're on github interface and there is literally a button to switch to the original:
image

@watson watson Dec 18, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I question the usefulness of this and would probably vote to just remove this section altogether

@simon-id simon-id Dec 18, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine with removing it. It was a request from @bengl on my original slack thread.

@watson watson Dec 19, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think he intended for people to click "edit source" to actually use it 😉

@simon-id simon-id Dec 21, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'll have to let him say what he intended himself, don't wanna put words into his mouth. Although, once again it's not clicking "edit source", it's clicking the file then the tab "code", which is available for all markdown files to see the original code instead of the markdown render.

@watson watson Jan 22, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The intent of this is not to show it nicely, but to make it easy to copy into your PR. So if we want to keep it (which I still doubt the usefulness of), it should be turned into a code block. If you show it "nicely", many users will just be very confused about why they can't click the check boxes.

@simon-id simon-id Jan 22, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed it completely 👍 not sure it's useful either



[1]: https://docs.datadoghq.com/help
[2]: https://github.com/DataDog/dd-trace-js/blob/master/index.d.ts
[3]: https://github.com/DataDog/dd-trace-js/blob/master/docs/test.ts
[4]: https://github.com/DataDog/documentation/blob/master/content/en/tracing/trace_collection/library_config/nodejs.md
[5]: https://github.com/DataDog/dd-trace-js/blob/master/.github/workflows/plugins.yml