Added first time contributors quick start information #4532
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -94,6 +94,51 @@ We ask all contributors to follow the practices explained in :doc:`the developer | |||
|
|
|||
| Please be sure to :ref:`run tests <colcon-run-the-tests>` for your code changes because most packages have tests that check that the code complies with our style guidelines. | |||
|
|
|||
| First Time Contributors | |||
| ^^^^^^^^^^^^^^^^^^^^^^^ | |||
| Reporting an Issue | |||
There was a problem hiding this comment.
Suggested change
| Reporting an Issue | |
| * Reporting an Issue |
Comment on lines
+101
to
+102
| * To report an issue, bug, or feature recommendation for this repository, please: | ||
| * Visit the Issues page of the repository |
There was a problem hiding this comment.
indent is 2 spaces, and this needs to apply else where. (this aligns with other sections in this page.)
Suggested change
| * To report an issue, bug, or feature recommendation for this repository, please: | |
| * Visit the Issues page of the repository | |
| * To report an issue, bug, or feature recommendation for this repository, please: | |
| * Visit the Issues page of the repository |
| * For example for rclpy, it would be: https://github.com/ros2/rclpy/issues | ||
| * Search to see if your issue is already documented. | ||
| * If it IS already documented, please: | ||
| #. Review the post and any comments/feedback or associated Pull Requests. Some issues cannot be resolved quickly, but sometimes the comments provide a solution that may help you in the interim. |
There was a problem hiding this comment.
one sentence per line.
Suggested change
| #. Review the post and any comments/feedback or associated Pull Requests. Some issues cannot be resolved quickly, but sometimes the comments provide a solution that may help you in the interim. | |
| #. Review the post and any comments/feedback or associated Pull Requests. | |
| Some issues cannot be resolved quickly, but sometimes the comments provide a solution that may help you in the interim. |
| * If it IS already documented, please: | ||
| #. Review the post and any comments/feedback or associated Pull Requests. Some issues cannot be resolved quickly, but sometimes the comments provide a solution that may help you in the interim. | ||
| #. If you wish, you may leave a comment on the post to help boost the issue. | ||
| #. If you notice that an Issue tag is missing from the post, you may choose to add it (ex. bug, help wanted, question, etc.). |
There was a problem hiding this comment.
i think in this case issue has been created by someone else, in this case probably we do not have permission to tag the label on the issue unless you have maintainer permission?
| #. Review the post and any comments/feedback or associated Pull Requests. Some issues cannot be resolved quickly, but sometimes the comments provide a solution that may help you in the interim. | ||
| #. If you wish, you may leave a comment on the post to help boost the issue. | ||
| #. If you notice that an Issue tag is missing from the post, you may choose to add it (ex. bug, help wanted, question, etc.). | ||
| #. Check back regularly to see if a solution has been found or other feedback provided to you. |
There was a problem hiding this comment.
we can subscribe the issue if we are interested, that would be more useful to receive the updates.
|
|
||
| To contribute to repositories, please: | ||
| * Read the License associated with the repository and Contributor Agreement above. | ||
| * For example, the license for rclpy is found at <https://github.com/ros2/rclpy/blob/rolling/LICENSE> |
There was a problem hiding this comment.
Suggested change
| * For example, the license for rclpy is found at <https://github.com/ros2/rclpy/blob/rolling/LICENSE> | |
| * For example, the license for rclpy is found at <https://github.com/ros2/rclpy/blob/{DISTRO}/LICENSE> |
Comment on lines
+121
to
+126
| * If you know what you want to contribute you may: | ||
| * Clone the repository. | ||
| * Make your changes. | ||
| * Start a new Pull Request in order to request the push of your code. | ||
| * To learn more about Pull Requests, you can visit the GitHub page here: <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests> | ||
| * Specify the changes you are making and detail thoroughly why the changes are being made. |
There was a problem hiding this comment.
i guess it is okay to have this guidelines here, but this is really similar with Github flow, can we just have a link to that?
|
@KristyWaters Friendly ping here, can you make the updates that @fujitatomoya suggested (and make sure that CI passes). Thanks! |
|
Since there has been no response in several months, closing this out. If you'd like to get this in, please feel free to address the comments and reopen. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the document I included a sort of quick start guide for first time contributors. As I attempted to get started contributing myself, I found myself very lost and confused. I am hoping that clarifying this information may help more contributors get going faster.
This pull request is based on the issue I opened in the rclpy repository. It was requested that I instead add it to this repository, and this seemed like the best fit location. Link to issue: ros2/rclpy#1290