improved testing/formatting section #36576
Conversation
CONTRIBUTING.md
Outdated
|
|
||
| ```bash | ||
| python3 -m pip install -r test/requirements.txt | ||
| ``` | ||
|
|
||
| To run the tests run ``nosetests`` in the root of the repository. | ||
| These tests require several dependencies that can be installed either from the ROS repositories or via pip(list built based on the content of [.travis.yaml](https://github.com/ros/rosdistro/blob/master/.travis.yml): | ||
| The following modules/packages are needed and will see install by avobe comment. |
There was a problem hiding this comment.
| The following modules/packages are needed and will see install by avobe comment. | |
| The following modules/packages are needed and will see install by above comment. |
There was a problem hiding this comment.
thanks, used it with a bit more of needed change.
|
Also please replace the body of the issue/PR with a real description to enable easier review for others in the future. |
done. |
There was a problem hiding this comment.
Thanks for the attention. @quarkytale Can you try this out and if it works for you merge?
|
|
||
| ```bash | ||
| python3 -m pip install -r test/requirements.txt | ||
| ``` | ||
|
|
||
| To run the tests run ``nosetests`` in the root of the repository. |
There was a problem hiding this comment.
This line made sense to me after installing dependencies, and after the list of installed modules.
| If you want to run the tests before submitting, first install the dependencies. Using `pip` is recommended. | ||
| #### Testing | ||
|
|
||
| To run the tests run ``nosetests`` (nose tests) in the root of the repository. |
There was a problem hiding this comment.
A separate section is a good idea but maybe some other intro line or about nose https://nose.readthedocs.io/en/latest/index.html? It would be better for uses to have the command after installing dependencies.
|
|
||
| To run the tests run ``nosetests`` (nose tests) in the root of the repository. | ||
|
|
||
| Note: There's a [known issue](https://github.com/disqus/nose-unittest/issues/2) discovered [here](https://github.com/ros/rosdistro/issues/16336) that most tests won't run if you have the python package `nose-unitttest` installed. |
There was a problem hiding this comment.
| Note: There's a [known issue](https://github.com/disqus/nose-unittest/issues/2) discovered [here](https://github.com/ros/rosdistro/issues/16336) that most tests won't run if you have the python package `nose-unitttest` installed. | |
| Note: There's a [known issue](https://github.com/disqus/nose-unittest/issues/2) discovered [here](https://github.com/ros/rosdistro/issues/16336) that most tests won't run if you have the python package `nose-unittest` installed. |
|
|
||
| ```bash | ||
| python3 -m pip install -r test/requirements.txt | ||
| ``` | ||
|
|
||
| To run the tests run ``nosetests`` in the root of the repository. | ||
| These tests require several dependencies that can be installed either from the ROS repositories or via pip(list built based on the content of [.travis.yaml](https://github.com/ros/rosdistro/blob/master/.travis.yml): | ||
| The following modules/packages are needed and will see install by the above command. |
There was a problem hiding this comment.
| The following modules/packages are needed and will see install by the above command. | |
| The following modules/packages are needed and will be installed by the above command. |
|
|
||
| Note: There's a [known issue](https://github.com/disqus/nose-unittest/issues/2) discovered [here](https://github.com/ros/rosdistro/issues/16336) that most tests won't run if you have the python package `nose-unitttest` installed. | ||
| There is further the tool ``rosdistro_reformat`` which will fix most formatting errors such as alphabetization and correct formatting. This tool takes an ``index`` parameter that is a required command line argument. With option ``-n`` a dry run is possible. |
There was a problem hiding this comment.
| There is further the tool ``rosdistro_reformat`` which will fix most formatting errors such as alphabetization and correct formatting. This tool takes an ``index`` parameter that is a required command line argument. With option ``-n`` a dry run is possible. | |
| There is a tool ``rosdistro_reformat`` which will fix most formatting errors such as alphabetization and correct formatting. This tool takes an ``index`` parameter that is a required command line argument. With option ``-n`` a dry run is possible. |
quarkytale
added
the
changes requested
|
Also might be worth noting |
eliminate deprecation warning on escapes by using raw string
eliminate deprecation warning with escape
|
Hi @AlexanderStohr would you like to address some of my previous comments before I give it another review |
|
@alexanderLinear are you still interested in addressing this feedback and updating this PR? |
sorry, was busy in recent times. |
|
This PR hasn't been activity in 14 days. If you are still are interested in getting it merged please provide an update. Otherwise it will likely be closed by a rosdistro maintainer following our contributing policy. It's been labeled "stale" for visibility to the maintainers. If this label isn't appropriate, you can ask a maintainer to remove the label and add the 'persistent' label. |
github-actions
bot
added
the
stale
|
Closing as stale per guidelines. If you still wish to contribute this change, feel free to open a new PR |
This pull request is purely about documentation improvements.
It first re-orders and slightly improves formatting so that the overall meaning and usability of the referenced tooling is eased.