Skip to content

Format of the whatsnew.txt

Jump to bottom
nofish edited this page May 31, 2020 · 6 revisions

In the root of the project, there's a file "whatsnew.txt". Any time changes are made to the repository, please update this file; add your new features at the top (i.e. above the section of the current version). (this is no longer required, see Submitting pull requests).

There's some special formatting rules, as this file is parsed to create the HTML you see at http://www.sws-extension.org/whatsnew.php:

  • Start a line with + to make it a bulleted list
  • Start a line with ! to make it a header (Header is added automatically by the build script, don't add yourself)
  • URLs are automatically parsed. If you want to have a URL with different text that the actual URL, use a | symbol after the link, and after the text, eg http://link.com|Link Text|
  • If you note a github issue with "issue xxx", it will automatically be converted to a link

See the existing whatsnew.txt for examples.

Clone this wiki locally