-
-
Notifications
You must be signed in to change notification settings - Fork 675
Move changelog to a folder and use single file entries #6325
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.
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
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| This directory will get copied to dlang.org and cleared when master gets | ||
| merged into stable prior to a new release. | ||
|
|
||
| How to add a new changelog entry to the pending changelog? | ||
| ========================================================== | ||
|
|
||
| Create a new file in the `changelog` folder. It should end with `.dd` and look | ||
| similar to a git commit message. The first line represents the title of the change. | ||
| After an empty line follows the long description: | ||
|
|
||
| ``` | ||
| My fancy title of the new feature | ||
|
|
||
| A long description of the new feature in `std.range`. | ||
| It can be followed by an example: | ||
| ------- | ||
| import std.range : padLeft, padRight; | ||
| import std.algorithm.comparison : equal; | ||
|
|
||
| assert([1, 2, 3, 4, 5].padLeft(0, 7).equal([0, 0, 1, 2, 3, 4, 5])); | ||
|
|
||
| assert("Hello World!".padRight('!', 15).equal("Hello World!!!!")); | ||
| ------- | ||
| and links to the documentation, e.g. $(REF drop, std, range) or | ||
| $(REF_ALTTEXT a custom name for the function, drop, std, range). | ||
|
|
||
| Links to the spec can look like this $(LINK2 $(ROOT_DIR)spec/module.html, this) | ||
| and of course you can link to other $(LINK2 https://forum.dlang.org/, external resources). | ||
| ``` | ||
|
|
||
| The title can't contain links (it's already one). | ||
| For more infos, see the [Ddoc spec](https://dlang.org/spec/ddoc.html). | ||
|
|
||
| Preview changes | ||
| --------------- | ||
|
|
||
| If you have cloned the [tools](https://github.com/dlang/tools) and [dlang.org](https://github.com/dlang/dlang.org) repo), | ||
| you can preview the changelog with: | ||
|
|
||
| ``` | ||
| make -C ../dlang.org -f posix.mak pending_changelog | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm just trying to add the changelog for druntime PR and I find this very confusing. Is what follows the content of the file? If so, what's the name of the file? Maybe add more documentation around here.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please see dlang/phobos#4228 for the motivation and examples.
Yes.
There's no fixed file name scheme except that the extension should be
.dd(Ddoc extension).Ok - Will do so later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, the intention was not confusing, but more how should I use it :-). As being one that wasn't involved in the motivation/examples, I just wanted to say that the
READMEis confusing as it doesn't provide clear guidelines what one should do (and there's no prior art in the same repo to rip it off)