Template:Upcoming
The following information pertains to an upcoming version ([[{{{1}}}]]). If this version is now released, please verify that the information below is still accurate, then update the page to incorporate it.
{{{2}}}Usage: Add this template when you want to add information about an upcoming, unreleased version of NetHack or possibly a variant. Example:
{{upcoming|NetHack 8.4.1|Foo monsters now appear in bar branch.}}
When adding an upcoming template:
- Be as specific as possible - you won't necessarily have a handy source reference to cite that will still be accurate in the released version of the code, so describe it as clearly as you can. If you want to reference a single commit, you can also use Template:Commit to produce a link to that commit on GitHub.
- If an entire page is about a feature from an upcoming version, one convention that's developed is to put this template as the very first thing in the page, with the description field providing the initial commit or else left blank, rather than putting the entire page inside this template.
When removing an upcoming template after a release occurs and editing the information into the page:
- Keep in mind that the editor who put the template there was going off a development version - there may have been some changes made to the source code after they added the template to the page. Check and make sure that the information is still valid. If commits are linked, don't just look at the diffs of those commits; look at the current state of the code as of the stable release.
- Don't just make a new paragraph saying "in X new version, it works like this", or saying "in versions before X, it worked like this". The article should describe the behavior in the current release, and should not have to make any qualifying statements about functionality in different versions. If it's really significant enough of a difference to note behavior in multiple versions, you can describe the previous version's behavior in a History section lower on the page.
- The article should ideally be as up to date with the latest stable version as possible before this information is added. Consider reviewing the rest of the page to verify nothing else on it needs to be updated for the new version, and then tag the page with the appropriate {{nethack-XYZ}} template.
The {{recent}} template is a related template option that works to establish recently-added information as being somewhat volatile and subject to changes, though it should not be used to simply substitute in for this template as noted in the bulleted lists: its purpose is to mark sections that will need constant attention to bring up to date, e.g. from heavy source-diving, major changes between versions, formulating strategy, or some combination of these and similar elements. This template adds the page to Category:Upcoming.