File: CONTRIBUTING.md

package info (click to toggle)
python-assertpy 1.1-1.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 628 kB
  • sloc: python: 5,712; makefile: 4; sh: 3
file content (41 lines) | stat: -rw-r--r-- 1,250 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# Contributing

Any contributions of docs or tests or code would be awesome.

Here's how:

1. Fork it
1. Clone your fork (`git clone https://my_fork`)
1. Create a branch (`git checkout -b my_branch`)
1. Commit your changes (`git commit -am "added some cool feature"`)
1. Push your branch to your fork (`git push origin my_branch`)
1. Open a [Pull Request](http://github.com/assertpy/assertpy/pulls)
1. Respond to any questions during our review process

Read more about how pulls work on GitHub's [About pull requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) page.

## Running the Tests

Before even thinking about sending us a pull request, you must first write some tests (and
eat some dogfood by using `assertpy` assertions in any tests you write).

Our favorite python test runner is [pytest](http://pytest.org/). To run all the
tests, just execute `py.test` in the base project folder (above the `tests/` folder)
like this:

```
PYTHONPATH=. py.test -v tests
```

Should produce output something like this:

```
===== test session starts =====
collected 589 items

tests/test_bool.py::test_is_true PASSED
..
tests/test_warn.py::test_failures PASSED

===== 589 passed in 1.91s =====
```