Skip to content

update contribution guide #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
beverlylytle merged 4 commits into from
Feb 2, 2021
Merged

update contribution guide #76

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c1f595d
update contribution guide
beverlylytle Feb 2, 2021
1af39a3
remove extra step
beverlylytle Feb 2, 2021
5ef39ed
Merge branch 'main' into contrib_update
beverlylytle Feb 2, 2021
09a7e59
remove extra whitespace
beverlylytle Feb 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,34 @@ We love pull requests from everyone! Here's a quick guide to improve the code:

pip install -r requirements-dev.txt

4. Make sure all tests pass:
4. Run the docker container:

::

docker run -d -p 9090:9090 --name roslibpy_integration_tests gramaziokohler/integration-tests-bridge /bin/bash -c "roslaunch /integration-tests.launch"

5. Make sure all tests pass:

::

invoke test

5. Start making your changes to the **main** branch (or branch off of it).
6. Make sure all tests still pass:
6. Start making your changes to the **main** branch (or branch off of it).
7. Make sure all tests still pass:

::

invoke test

7. Add yourself to ``AUTHORS.rst``.
8. Commit your changes and push your branch to GitHub.
9. Create a `pull request <https://help.github.com/articles/about-pull-requests/>`_ through the GitHub website.
8. Stop your docker container:

::

docker stop roslibpy_integration_tests

9. Add yourself to ``AUTHORS.rst``.
10. Commit your changes and push your branch to GitHub.
11. Create a `pull request <https://help.github.com/articles/about-pull-requests/>`_ through the GitHub website.


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