Skip to content

Commit 4ebab88

Browse files
committed
Add screenshot to front page
Also: - Updated pythong_scripting.py example to show how to colorize text - Updated contributing.md to show how to run code coverage in parallel using python-xdist and -nauto - Updated contributing.md to talk more about looking at unit test results within the PR
1 parent b581fd5 commit 4ebab88

File tree

4 files changed

+12
-2
lines changed

4 files changed

+12
-2
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ where `4` should be replaced by the number of parallel threads you wish to run f
274274
Code coverage can be measured as follows:
275275

276276
```shell
277-
py.test --cov=cmd2 --cov-report term-missing --cov-report=html
277+
py.test -nauto --cov=cmd2 --cov-report=term-missing --cov-report=html
278278
```
279279

280280
Then use your web browser of choice to look at the results which are in `<cmd2>/htmlcov/index.html`.
@@ -390,6 +390,14 @@ how to do it.
390390

391391
6. Indicate what local testing you have done (e.g. what OS and version(s) of Python did you run the
392392
unit test suite with)
393+
394+
7. Creating the PR causes our continuous integration (CI) systems to automatically run all of the
395+
unit tests on all supported OSes and all supported versions of Python. You should watch your PR
396+
to make sure that all unit tests pass on Both TravisCI (Linux) and AppVeyor (Windows).
397+
398+
8. If any unit tests fail, you should look at the details and fix the failures. You can then push
399+
the fix to the same branch in your fork and the PR will automatically get updated and the CI system
400+
will automatically run all of the unit tests again.
393401

394402

395403
### How We Review and Merge Pull Requests

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ applications. It provides a simple API which is an extension of Python's built-
1313
of cmd to make your life easier and eliminates much of the boilerplate code which would be necessary
1414
when using cmd.
1515

16+
[![Screenshot](cmd2.png)](https://github.com/python-cmd2/cmd2/blob/master/cmd2.png)
17+
1618

1719
Main Features
1820
-------------

cmd2.png

287 KB
Loading

examples/python_scripting.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ def __init__(self):
3636
def _set_prompt(self):
3737
"""Set prompt so it displays the current working directory."""
3838
self.cwd = os.getcwd()
39-
self.prompt = '{!r} $ '.format(self.cwd)
39+
self.prompt = self.colorize('{!r} $ '.format(self.cwd), 'cyan')
4040

4141
def postcmd(self, stop, line):
4242
"""Hook method executed just after a command dispatch is finished.

0 commit comments

Comments
 (0)