Skip to content

Commit 1507567

Browse files
authored
Merge pull request #76 from gramaziokohler/contrib_update
update contribution guide
2 parents d5a704b + 09a7e59 commit 1507567

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

CONTRIBUTING.rst

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,34 @@ We love pull requests from everyone! Here's a quick guide to improve the code:
1616

1717
pip install -r requirements-dev.txt
1818

19-
4. Make sure all tests pass:
19+
4. Run the docker container:
20+
21+
::
22+
23+
docker run -d -p 9090:9090 --name roslibpy_integration_tests gramaziokohler/integration-tests-bridge /bin/bash -c "roslaunch /integration-tests.launch"
24+
25+
5. Make sure all tests pass:
2026

2127
::
2228

2329
invoke test
2430

25-
5. Start making your changes to the **main** branch (or branch off of it).
26-
6. Make sure all tests still pass:
31+
6. Start making your changes to the **main** branch (or branch off of it).
32+
7. Make sure all tests still pass:
2733

2834
::
2935

3036
invoke test
3137

32-
7. Add yourself to ``AUTHORS.rst``.
33-
8. Commit your changes and push your branch to GitHub.
34-
9. Create a `pull request <https://help.github.com/articles/about-pull-requests/>`_ through the GitHub website.
38+
8. Stop your docker container:
39+
40+
::
41+
42+
docker stop roslibpy_integration_tests
43+
44+
9. Add yourself to ``AUTHORS.rst``.
45+
10. Commit your changes and push your branch to GitHub.
46+
11. Create a `pull request <https://help.github.com/articles/about-pull-requests/>`_ through the GitHub website.
3547

3648

3749
During development, use `pyinvoke <http://docs.pyinvoke.org/>`_ tasks on the

0 commit comments

Comments
 (0)