From 1eccb685509cfbcf4b0d0a5a37b23a19d5f27eec 2013-08-19 23:19:57 From: Paul Ivanov Date: 2013-08-19 23:19:57 Subject: [PATCH] mention pr folder in whatsnew and CONTRIBUTING --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 328b2d5..a219570 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,6 +28,10 @@ Some guidelines on contributing to IPython: * Pull Requests should be tested, if feasible: - bugfixes should include regression tests - new behavior should at least get minimal exercise +* New features and backwards-incompatible changes should be documented by adding + a new file to the [development](docs/source/whatsnew/development) directory, + see [the README.md there](docs/source/whatsnew/development/README.md) for + details. [Travis](http://travis-ci.org/#!/ipython/ipython) does a pretty good job testing IPython and Pull Requests, but it may make sense to manually perform tests (possibly with our `test_pr` script), diff --git a/docs/source/whatsnew/development.rst b/docs/source/whatsnew/development.rst index 459f2d7..68cd9f3 100644 --- a/docs/source/whatsnew/development.rst +++ b/docs/source/whatsnew/development.rst @@ -4,6 +4,13 @@ This document describes in-flight development work. +.. warning:: + + Please do not edit this file by hand (doing so will likely cause merge + conflicts for other Pull Requests). Instead, create a new file in the + `docs/source/whatsnew/pr` folder + + - `%%capture` cell magic now captures the rich display output, not just stdout/stderr