Create contributing to ros#6918
Conversation
…or-openrobotics/ros2_documentation into create-contributing-to-ros
|
@gbiggs it would be great if you could take a look at the "contributing..." article in this PR. This is the one designed to encourage all types of contribution, and make it really clear what a first contribution could be. Vanessa too (sorry - don't know her username so can't tag) |
|
This pull request relates to #6828 but the link didn't work in the description. FYI @sarahfarnborough-3di. |
|
Hello @gbiggs - we'd really appreciate your review of the "Contributing to ROS" article in this PR, which is designed to encourage all types of contribution, and make it really clear what a first contribution could be. We'd need a review from Vanessa too - (sorry, we don't know her username so can't tag her). |
| ======= | ||
|
|
||
| .. _Using Robotics Stack Exchange: | ||
| Contact us the ROS community to ask for support, offer help, or suggest ways we can improve. |
There was a problem hiding this comment.
| Contact us the ROS community to ask for support, offer help, or suggest ways we can improve. | |
| To contact the ROS community to ask for support, offer help, or suggest ways we can improve. |
|
|
||
| * `Zulip chat <https://openrobotics.zulipchat.com/Recent>`_ | ||
| (QUESTION FOR THE REVIEWER: What is the purpose for this one? | ||
| Is it meant more for people who are involved in developing ROS rather than for users with questions?) |
There was a problem hiding this comment.
Yes, both, it is basically a Discord server. If you want to chat with someone in real time it is probably your best bet. Questions should be directed to the General or the ROS General topics.
| <Placeholder link to new "Reporting an issue" article> | ||
|
|
||
| You can search for individual ROS 2 repositories on `ROS 2's GitHub <https://github.com/ros2>`__. | ||
| .. note:: If you have a private, sensitive, or security issue, email us directly at `ros@rosfoundation.org <mailto:ros@srosfoundation.org>`__. |
There was a problem hiding this comment.
Security issues use a different e-mail address, namely security@openrobotics.org.
Also I don't believe the current address is correct.
| The diverse community behind the ROS ecosystem is one of its greatest assets. | ||
| We encourage all members of the ROS community to participate in these design discussions so that we can leverage the experience of community members, and keep the varied use cases of ROS in mind. | ||
| If you'd like to contact us privately, for example, if your question contains information sensitive to your organization or project, or if it's regarding a | ||
| security issue, you can email us directly at `ros@rosfoundation.org <mailto:ros@rosfoundation.org>`__. |
There was a problem hiding this comment.
This e-mail address is not correct. I think ros@openrobotics.org is what you want.
There was a problem hiding this comment.
Also, security issues should go to the security@ email address as Kat mentioned above.
| ======= | ||
|
|
||
| .. _Using Robotics Stack Exchange: | ||
| Contact us the ROS community to ask for support, offer help, or suggest ways we can improve. |
There was a problem hiding this comment.
Remove the 'us'.
| Contact us the ROS community to ask for support, offer help, or suggest ways we can improve. | |
| Contact the ROS community to ask for support, offer help, or suggest ways we can improve. |
| check the descriptions below to ensure you choose the right method. | ||
| You can contact the ROS community in the following ways: | ||
|
|
||
| * `Stack Exchange <https://robotics.stackexchange.com/>`__: Ask for support or discuss an issue |
There was a problem hiding this comment.
"Issue" implies a GitHub issue to me. Suggest "problem" instead.
There was a problem hiding this comment.
| * `Stack Exchange <https://robotics.stackexchange.com/>`__: Ask for support or discuss an issue | |
| * `Stack Exchange <https://robotics.stackexchange.com/>`__: Ask for support or discuss a problem |
| (QUESTION FOR THE REVIEWER: What is the purpose for this one? | ||
| Is it meant more for people who are involved in developing ROS rather than for users with questions?) | ||
|
|
||
| * `Email <mailto:ros@osrfoundation.org>`_: Contact us directly if you have a private, sensitive, or security issue |
There was a problem hiding this comment.
I believe this should be ros@openrobotics.org. @gbiggs ?
There was a problem hiding this comment.
I thought we had a different email for security reports, but I only see a security@osrfoundation.org address and I don't think that's the one we want. @gbiggs ?
| If not, ask a new question on `Robotics Stack Exchange <https://robotics.stackexchange.com/>`__. | ||
| Make sure to add tags, at the very least the ``ros2`` tag and the distro version you are running, e.g. ``{DISTRO}``. | ||
| If your question is related to the documentation here, add a tag like ``docs``, or more specifically, ``tutorials``. | ||
| If your question is related to the documentation, add a tag like ``docs``, or more specifically, ``tutorials``. |
There was a problem hiding this comment.
To me this reads like the suggestion is to use a tutorials tag on all docs questions. Perhaps: "If your question is related to the documentation, add a docs tag and, optionally, a tag for the specific area of the documentation like tutorials."
| If your question is related to the documentation, add a tag like ``docs``, or more specifically, ``tutorials``. | ||
|
|
||
| Please don't contact the developers/maintainers directly. | ||
| The community can't see question or answer(s) not asked or answered publicly. |
There was a problem hiding this comment.
Suggested rephrase: "The community can't benefit from private answers and questions. Keep your questions out in the public to help others solve their problems."
| There are various ways to join the ROS community, allowing you to participate, collaborate, and contribute effectively. | ||
| Here are some ways you can join in: | ||
|
|
||
| * Attend events, from local informal meetings to our annual developer conference, `ROSCON <https://roscon.ros.org/OSR/>`_: |
There was a problem hiding this comment.
Please drop the /OSR/ from this URL. As-is, it 404s. Plain ol' roscon.ros.org is the way to go.
|
|
||
| * Host an online community group event: `Fill in the form to add your event to the calendar <https://bit.ly/OSRFCalendarForm/>`_ | ||
| (QUESTION FOR THE REVIEWER: Is there someone or a channel people can contact if they are thinking of doing this, but need a bit of guidance or support? | ||
| If so, can we link to that here?) |
There was a problem hiding this comment.
@kscottz Would you prefer people put something in Zulip if they need this sort of support?
There was a problem hiding this comment.
Officially the calendar is the location but honestly a post on Discourse works better.
There was a problem hiding this comment.
Asking on Zulip or Discourse is reasonable.
| If so, can we link to that here?) | ||
|
|
||
| * Host a local meet-up: `Fill in the form to add your event to the calendar <https://bit.ly/OSRFCalendarForm/>`_ | ||
| (QUESTION FOR THE REVIEWER: Is there someone or a channel people can contact if they are thinking of doing this, but need a bit of guidance or support? |
There was a problem hiding this comment.
@kscottz Same question here, but the answer would hopefully be temporary. I now have the "docs/packet for meetup people" on my radar.
| * Support people with working through the tutorials, starting with `First steps with ROS <https://docs.ros.org/en/lyrical/First-Steps.html>`_ | ||
|
|
||
| * Be part of our community on social media: <Placeholder link to ROS sm channel(s)> | ||
| (QUESTION FOR THE REVIEWER: Can we link to Open Robotics / ROS social media channels?) |
There was a problem hiding this comment.
I don't have a full list of these yet. It'd be best if we had a list on the website where you could link, but IIRC we don't.
@kscottz Do you have a list for them?
There was a problem hiding this comment.
Best spot is probably the list of project resources on docs.ros.org.
| Becoming an OSRA member lets you influence the organization's direction, collaborate with a wider community, and contribute more directly to the growth and | ||
| impact of our projects. | ||
|
|
||
| Learn more about becoming an OSRA member https://osralliance.org/ |
There was a problem hiding this comment.
Direct membership info URL: https://osralliance.org/membership/
But we may want the (linked; the above isn't) link to the OSRA homepage and change the text to something like, "Learn more about OSRA and becoming a member".
| check the descriptions below to ensure you choose the right method. | ||
| You can contact the ROS community in the following ways: | ||
|
|
||
| * `Stack Exchange <https://robotics.stackexchange.com/>`__: Ask for support or discuss an issue |
There was a problem hiding this comment.
| * `Stack Exchange <https://robotics.stackexchange.com/>`__: Ask for support or discuss an issue | |
| * `Stack Exchange <https://robotics.stackexchange.com/>`__: Ask for support or discuss a problem |
| * `Zulip chat <https://openrobotics.zulipchat.com/Recent>`_ | ||
| (QUESTION FOR THE REVIEWER: What is the purpose for this one? | ||
| Is it meant more for people who are involved in developing ROS rather than for users with questions?) |
There was a problem hiding this comment.
| * `Zulip chat <https://openrobotics.zulipchat.com/Recent>`_ | |
| (QUESTION FOR THE REVIEWER: What is the purpose for this one? | |
| Is it meant more for people who are involved in developing ROS rather than for users with questions?) | |
| * `Zulip chat <https://openrobotics.zulipchat.com/Recent>`_ | |
| Chat with other community members, including the maintainers, about ROS, and see project work happening in real-time |
| (QUESTION FOR THE REVIEWER: What is the purpose for this one? | ||
| Is it meant more for people who are involved in developing ROS rather than for users with questions?) | ||
|
|
||
| * `Email <mailto:ros@osrfoundation.org>`_: Contact us directly if you have a private, sensitive, or security issue |
There was a problem hiding this comment.
| * `Email <mailto:ros@osrfoundation.org>`_: Contact us directly if you have a private, sensitive, or security issue | |
| * `Email <mailto:ros@openrobotics.org>`_: Contact us directly if you have a private or sensitive issue | |
| * `Email (security matters) <mailto:security@openrobotics.org`_: Contact us directly if you have found a security problem in ROS |
| First, search `Robotics Stack Exchange <https://robotics.stackexchange.com/>`__ to see if others have had similar issues, and if their solution works for you. | ||
|
|
||
| If not, ask a new question on `Robotics Stack Exchange <https://robotics.stackexchange.com/>`__. | ||
| Make sure to add tags, at the very least the ``ros2`` tag and the distro version you are running, e.g. ``{DISTRO}``. |
There was a problem hiding this comment.
| Make sure to add tags, at the very least the ``ros2`` tag and the distro version you are running, e.g. ``{DISTRO}``. | |
| Make sure to add tags, at the very least the ``ros`` tag and the distro version you are running, e.g. ``{DISTRO}``. |
We are moving to just saying "ROS" everywhere, now that ROS 1 is a year past EOL.
| If not, ask a new question on `Robotics Stack Exchange <https://robotics.stackexchange.com/>`__. | ||
| Make sure to add tags, at the very least the ``ros2`` tag and the distro version you are running, e.g. ``{DISTRO}``. | ||
| If your question is related to the documentation here, add a tag like ``docs``, or more specifically, ``tutorials``. | ||
| If your question is related to the documentation, add a tag like ``docs``, or more specifically, ``tutorials``. |
There was a problem hiding this comment.
| If your question is related to the documentation, add a tag like ``docs``, or more specifically, ``tutorials``. | |
| If your question is related to the documentation, add a tag like ``docs``, and, optionally, a tag for the specific area of the documentation, such as ``tutorials`` or ``concepts``. |
| If you notice a question on Robotics Stack Exchange that relates to an issue you have encountered, consider sharing what worked for you. | ||
| If you aren't entirely sure your answer is correct, just say so. | ||
| The community is there to help, and others will step in to clarify or add more detail if needed. | ||
|
|
There was a problem hiding this comment.
| Helping others is also one of the fastest and most effective ways to improve your own ROS knowledge. | |
| Even if you don't know the answer to someone's question immediately, try finding a solution, and when you have one, post that as an answer to the question. | |
| There are various ways to join the ROS community, allowing you to participate, collaborate, and contribute effectively. | ||
| Here are some ways you can join in: | ||
|
|
||
| * Attend events, from local informal meetings to our annual developer conference, `ROSCON <https://roscon.ros.org/OSR/>`_: |
There was a problem hiding this comment.
| * Attend events, from local informal meetings to our annual developer conference, `ROSCON <https://roscon.ros.org/OSR/>`_: | |
| * Attend events, from local informal meetings to our annual developer conference, `ROSCon <https://roscon.ros.org/>`_: |
There was a problem hiding this comment.
@vmbrasseur Need a link to the events calendar here when it's ready.
|
|
||
| * Host an online community group event: `Fill in the form to add your event to the calendar <https://bit.ly/OSRFCalendarForm/>`_ | ||
| (QUESTION FOR THE REVIEWER: Is there someone or a channel people can contact if they are thinking of doing this, but need a bit of guidance or support? | ||
| If so, can we link to that here?) |
There was a problem hiding this comment.
Asking on Zulip or Discourse is reasonable.
| Becoming an OSRA member lets you influence the organization's direction, collaborate with a wider community, and contribute more directly to the growth and | ||
| impact of our projects. |
There was a problem hiding this comment.
| Becoming an OSRA member lets you influence the organization's direction, collaborate with a wider community, and contribute more directly to the growth and | |
| impact of our projects. | |
| Becoming an OSRA member lets you influence the organization's direction, collaborate with a wider community, and contribute more directly to the growth and impact of our projects. |
| Becoming an OSRA member lets you influence the organization's direction, collaborate with a wider community, and contribute more directly to the growth and | ||
| impact of our projects. | ||
|
|
||
| Learn more about becoming an OSRA member https://osralliance.org/ |
There was a problem hiding this comment.
| Learn more about becoming an OSRA member https://osralliance.org/ | |
| `Learn more about becoming an OSRA member <https://osralliance.org/membership/>`_. |
8 participants
3di | New 'Contributing to ROS' article and updated 'Contact' article
This is draft pull request. Both of the articles included in this pull request are dependent on the ToC structure being reoganized.
Contributing to ROS
Created a new article about the ways in which the community can contribute to ROS.
Used Geoff's notes about the priority for and detail of what’s important for each type of contribution.
Contact
Related to: #6828
Did you use Generative AI?
No
Additional Information
Documentation updates from 3di Information Solutions, agreed with Geoff and Tully.