From b7ff45a878f8f216266eac9f4b726d9b8a544ef1 Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Tue, 30 Jan 2024 03:51:56 +0100 Subject: [PATCH] Re-add a PR preparation intro from PR #7916 --- docs/contributing.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index efa95ae4afe..d35e9cd9c4f 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -261,13 +261,22 @@ To run spell checker on Linux box you should install it first: $ pip install sphinxcontrib-spelling +Preparing a pull request +------------------------ + +When making a pull request, please include a short summary of the changes +and a reference to any issue tickets that the PR is intended to solve. +All PRs with code changes should include tests. All changes should +include a changelog entry. + + Changelog update ---------------- .. include:: ../CHANGES/README.rst -Making a Pull Request +Making a pull request --------------------- After finishing all steps make a GitHub_ Pull Request with *master* base branch.