Goal:
Find an issue that needs a release note, and write a succinct summary of the change.
Skills required:
Detailed steps:
- Set up prerequisites: Log in from Common Prerequisites for Contributors.
- Find an issue to work on, with a preference for Drupal core issues. Issues that need release notes are tagged with Needs release note. Look for an issue that has the status "Reviewed and Tested by the Community" (RTBC), "Needs Review", or a core committer updated the issue to "Needs work" because it does not have a release note.
- Visit the issue page by clicking on the issue title in the search results.
- Read the issue summary to understand the problem being solved or the change being made, including the impact and what developers or site builders would need to do about it, if anything.
- Edit the issue summary. The field containing the summary is below the comment form at the bottom of the issue page, inside the Issue summary and relationships fieldset. Follow these steps. Read the "Release notes snippet" section of the Issue summary field documentation to find examples of release notes.
- Add a Release Note heading level 3, if it does not already exist, at the bottom of the issue summary.
- Write a release note that will:
- Help the site owner or module developer understand if they are affected.
- Summarize the disruption.
- Be succinct.
- Link the change record for further details, if necessary.
- Remove the "Needs release note" tag. Inside of the Issue metadata fieldset, remove the "Needs release note" tag from Issue tags field making sure to leave other issue tags intact.
- Write a comment and update.
- Write a Comment indicating the task you have completed mentioning anybody else you worked with while writing the Release note.
- Click Save at the bottom of the page to save your changes and comment.