diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2018-09-20 23:38:00 -0400 |
|---|---|---|
| committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2018-09-20 23:38:00 -0400 |
| commit | 4d080c02f024b4ff4fa76e2966c1874591b37756 (patch) | |
| tree | 8290398afcf13a0dbe5cb4cc667329d51d81a128 /README.md | |
| parent | 08ddffdda91cf553bb08a1369786fc782e04b796 (diff) | |
| download | cmd2-git-4d080c02f024b4ff4fa76e2966c1874591b37756.tar.gz | |
Made various fixes and improvements to contributor's guide
Including:
- Fixed broken link
- Added missing section to TOC
- Updated prerequisites
- Updated instructions for publishing a release
Also:
- Added section to end of Readme.md giving users instructions on what to do if they find a bug
Diffstat (limited to 'README.md')
| -rwxr-xr-x | README.md | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -259,3 +259,15 @@ timing: False Note how a regular expression `/(True|False)/` is used for output of the **show color** command since colored text is currently not available for cmd2 on Windows. Regular expressions can be used anywhere within a transcript file simply by enclosing them within forward slashes, `/`. + + +Found a bug? +------------ + +If you think you've found a bug, please first read through the open [Issues](https://github.com/python-cmd2/cmd2/issues). If you're confident it's a new bug, go ahead and create a new GitHub issue. Be sure to include as much information as possible so we can reproduce the bug. At a minimum, please state the following: + +* ``cmd2`` version +* Python version +* OS name and version +* What you did to cause the bug to occur +* Include any trackeback or error message associated with the bug |