Add instructions for creating change notes. #7400
Conversation
Adding change notes.md
Outdated
| @@ -0,0 +1,69 @@ | ||
| # Adding change notes for query and library changes | ||
|
|
||
| Each CodeQL query pack or library pack has its own change log to track how that pack changes with each release. Any non-trivial, user-visible change to a query or library should add a change note to the affected pack. This document describes how to do that. |
There was a problem hiding this comment.
We should have a change note validation step as part of CI. It should just ensure the change notes are well-formed. Not blocking for this change, though.
There was a problem hiding this comment.
Yeah, that's the plan. Probably just a switch to codeql pack changelog or something.
Co-authored-by: Aditya Sharad <6874315+adityasharad@users.noreply.github.com>
Nice. I'm happy with this and we can keep improving it over time. Up to you if you want further review from the language teams, as they will be the ones writing these notes.
|
Leaving this open for a day or so to allow for more comments. |
Co-authored-by: Anders Schack-Mulligen <aschackmull@users.noreply.github.com>
Since this is a change to how users will contribute queries to this repository, it seems like we should add a change note somewhere about this change note. I don't think we need to be putting it into the change notes for the individual libraries, but possibly we can add a note to the CodeQL CLI with a pointer to these new instructions.
No description provided.
The text was updated successfully, but these errors were encountered: