Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 0 additions & 33 deletions changelog.dd

This file was deleted.

42 changes: 42 additions & 0 deletions changelog/README.md
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:

```
Copy link
Contributor

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.

Copy link
Contributor Author

@wilzbach wilzbach Dec 22, 2016

Choose a reason for hiding this comment

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

I find this very confusing

Please see dlang/phobos#4228 for the motivation and examples.

Is what follows the content of the file?

Yes.

If so, what's the name of the file?

There's no fixed file name scheme except that the extension should be .dd (Ddoc extension).

Maybe add more documentation around here.

Ok - Will do so later.

Copy link
Contributor

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.

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 README is 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)

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
```