|
1 |
| -# Questions |
| 1 | +# Contributing |
| 2 | + |
| 3 | +## Questions |
2 | 4 |
|
3 | 5 | If you are having difficulties using the APIs or have a question about the IBM Watson Services,
|
4 | 6 | please ask a question on [dW Answers][dw] or [Stack Overflow][stackoverflow].
|
5 | 7 |
|
6 |
| -# Issues |
| 8 | +## Issues |
7 | 9 |
|
8 | 10 | If you encounter an issue with the Python SDK, you are welcome to submit a [bug report](https://github.com/watson-developer-cloud/python-sdk/issues).
|
9 | 11 | Before that, please search for similar issues. It's possible somebody has encountered this issue already.
|
10 | 12 |
|
11 | 13 | ## Pull Requests
|
12 | 14 |
|
13 | 15 | If you want to contribute to the repository, here's a quick guide:
|
14 |
| - 1. Fork the repository |
15 |
| - 2. develop and test your code changes with [pytest]. |
| 16 | + |
| 17 | +1. Fork the repository |
| 18 | +1. Install `virtualenv` and `tox` |
| 19 | +1. Develop and test your code changes with [pytest]. |
16 | 20 | * Respect the original code [style guide][styleguide].
|
17 | 21 | * Only use spaces for indentation.
|
18 | 22 | * Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
|
19 |
| - * Check for unnecessary whitespace with git diff --check before committing. |
20 |
| - 3. Make the test pass |
21 |
| - 4. Commit your changes |
22 |
| - 5. Push to your fork and submit a pull request to the `dev` branch |
| 23 | + * Check for unnecessary whitespace with `git diff --check` before committing. |
| 24 | + * Make sure your code supports Python 2.7, 3.4, 3.5 and 3.6. You can use `pyenv` and `tox` for this |
| 25 | +1. Make the test pass |
| 26 | +1. Commit your changes |
| 27 | +1. Push to your fork and submit a pull request to the `dev` branch |
23 | 28 |
|
24 | 29 | ## Running the tests
|
25 | 30 |
|
26 | 31 | You probably want to set up a [virtualenv].
|
27 | 32 |
|
28 |
| - 1. Clone this repository: |
29 |
| - ``` |
| 33 | +1. Clone this repository: |
| 34 | + ```sh |
30 | 35 | git clone https://github.com/watson-developer-cloud/python-sdk.git
|
31 | 36 | ```
|
32 |
| - 2. Install the sdk as an editable package using the current source: |
33 |
| - ``` |
| 37 | +1. Install the sdk as an editable package using the current source: |
| 38 | + ```sh |
34 | 39 | pip install --editable .
|
35 | 40 | ```
|
36 |
| - 3. Install the test dependencies with: |
37 |
| -``` |
38 |
| -pip install -r requirements-dev.txt |
39 |
| -``` |
40 |
| - 4. Run the test cases with: |
| 41 | +1. Install the test dependencies with: |
| 42 | + ```sh |
| 43 | + pip install -r requirements-dev.txt |
41 | 44 | ```
|
| 45 | +1. Run the test cases with: |
| 46 | + ```sh |
42 | 47 | py.test test
|
43 | 48 | ```
|
44 | 49 |
|
45 | 50 | ## Additional Resources
|
46 |
| -+ [General GitHub documentation](https://help.github.com/) |
47 |
| -+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/) |
| 51 | + |
| 52 | +* [General GitHub documentation](https://help.github.com/) |
| 53 | +* [GitHub pull request documentation](https://help.github.com/send-pull-requests/) |
48 | 54 |
|
49 | 55 | [dw]: https://developer.ibm.com/answers/questions/ask/?topics=watson
|
50 | 56 | [stackoverflow]: http://stackoverflow.com/questions/ask?tags=ibm-watson
|
|
0 commit comments