Guidelines for release notes

[abarichello]

Format

Patch notes should follow this format:
<feature title> (<pr number with link when possible>)
Example:
Fixed hardpoints getting stuck on amped status (R2Northstar/NorthstarMods#199)

Localization files

If localization files are updated include the phrase below:
Updated the localization files

There's no need to be specific when doing minor updates to language files. This also makes a cool reference to that TF2 meme.

Script to generate list of contributors to be used in release notes.

Use this script to make this cool section on release notes:

1. Go to https://github.com/R2Northstar/Northstar/graphs/contributors (should be done for all repos).
2. Select the date range since last release.
3. Copy the code below and paste it into the browser console.
4. Copy the console output and post it into the 'Contributors' section of release notes.

var contributors = [];
for (doc of document.getElementsByClassName("text-normal")) {
  if (doc.getAttribute("data-hovercard-type") == "user") {
    var username = "@" + doc.innerText;
    if (!contributors.includes(username)) {
      contributors.push(username);
    }
  }
}
contributors.sort();
console.log(contributors);

Extras

For bigger releases, images should be added at the top highlighting particular changes/features of that release.