added changelog info#2
Conversation
| `/doc/build/changelog/unreleased_{Version}/{IssueId}.rst`, in which | ||
| `IssueId` is the auto-generated GitHub Issue Id. | ||
| </li> | ||
| <li>If the PR does not have a corresponding issue, use a placeholder file |
There was a problem hiding this comment.
any PR that warrants a changelog entry would need to have an issue number. I very rarely make changelog-worthy changes without creating an issue and outside contributors shouldn't be doing it ever.
| or sub-optimal way. Having a bug or feature issue opened ahead of time | ||
| will allow us to to understand the use case and discuss the best approach | ||
| before the contributor makes the effort to write the code and tests.</li> | ||
| before the contributor makes the effort to write the code and tests. The Github |
There was a problem hiding this comment.
"The issue number used by Github is also linked in the changelog and is used to generate a changelog file entry for merge."
| in your PR to generate a unique identifier for the PR, and then rename | ||
| the placeholder file to use the PR identifer for the `IssueId`. | ||
| </li> | ||
| <li>The changelog file format will hopefully be self-documenting |
There was a problem hiding this comment.
"The file format for a changelog file uses the .rst markup described at https://github.com/sqlalchemyorg/changelog . See the README.txt file in the doc/build/unreleased_XX" directory for an example"
(then we have to add examples of the format in the README.txt files.... )
|
@jvanasco any update on this one? |
|
Thanks for the ping. I think I forgot to push the commits? Will do tomorrow! |
|
abandoning this in favor of #5 |
3 participants
Referencing Mike's comment in : gordthompson/sqlalchemy-access#3 (comment)
I've Integrated the copy I proposed in : #1