From 1b2620ea99c3a83e9664e563d3705b2b8e7813b3 Mon Sep 17 00:00:00 2001 From: Tim Seckinger Date: Tue, 12 Feb 2019 20:28:45 +0100 Subject: [PATCH] contributing guide section about changelog entries --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c22883451815..fef3dcfc0686 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -72,6 +72,15 @@ _Before_ submitting a pull request, please make sure the following is done… 1. If you haven't already, complete the CLA. + +#### Changelog entries + +All changes that add a feature to or fix a bug in any of Jest's packages require a changelog entry containing the names of the packages affected, a description of the change, and the number of and link to the pull request. Try to match the structure of the existing entries. + +For significant changes to the documentation or website and things like cleanup, refactoring, and dependency updates, the "Chore & Maintenance" section of the changelog can be used. + +You can add or edit the changelog entry in the GitHub web interface once you have opened the pull request and know the number and link to it. + #### Testing Code that is written needs to be tested to ensure that it achieves the desired behaviour. Tests either fall into a unit test or an integration test.