Skip to content

docs: add community contribution guides - #6858

Open
Supull wants to merge 6 commits into
ros2:rollingfrom
Supull:fix/community-contribution-docs
Open

docs: add community contribution guides#6858
Supull wants to merge 6 commits into
ros2:rollingfrom
Supull:fix/community-contribution-docs

Conversation

@Supull

@Supull Supull commented May 25, 2026

Copy link
Copy Markdown

Fixes #6828

  • Add Community-Contributing overview
  • Add Reporting-An-Issue how-to
  • Add Making-A-Pull-Request how-to
  • Add Reviewing-A-Pull-Request how-to
  • Add Triaging-An-Issue how-to
  • Link all new guides in Contributing.rst toctree
  • Update Contact.rst to link new guides
  • Update index.rst to mention community guides
  • Add quick start section to Contributing-To-ROS-2-Documentation.rst
  • Add language summary table to Code-Style-Language-Versions.rst

Did you use Generative AI?

Gemini used to help write the new RST files with better wording.

Additional Information

No new dependencies. Build passes with no warnings or errors.

@fujitatomoya fujitatomoya left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm not against adding contribution guides in principle, but this is fairly standard Git/GitHub workflow that's already well documented elsewhere. i'd rather not maintain generic workflow docs in this repo unless they capture procedures or rules specific to ROS 2 contributions. let's hear more feedback on this.

@Supull

Supull commented May 29, 2026

Copy link
Copy Markdown
Author

i'm not against adding contribution guides in principle, but this is fairly standard Git/GitHub workflow that's already well documented elsewhere. i'd rather not maintain generic workflow docs in this repo unless they capture procedures or rules specific to ROS 2 contributions. let's hear more feedback on this.

Thanks for the feedback I will keep an eye on the discussion

@kscottz

kscottz commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

Thanks a bunch @Supull. We actually have some help from a contractor putting together a more in depth series on contribution. We would really value some feedback on that front. You are more than welcome to review #6901 and #6892.

@Supull

Supull commented Jun 18, 2026

Copy link
Copy Markdown
Author

Thanks a bunch @Supull. We actually have some help from a contractor putting together a more in depth series on contribution. We would really value some feedback on that front. You are more than welcome to review #6901 and #6892.

Thanks @kscottz I am happy to take a look. I'll review #6901 and #6892 and leave feedback there.

@kscottz kscottz self-assigned this Jun 18, 2026
@RachelPotts

Copy link
Copy Markdown

@Supull and @kscottz
We've taken a look at these, and there's a lot of overlap with a package of work we're quite advanced with already.
We'll do a skim for anything that can obviously be incorporated there, but the most effective thing will be to take a look at our PRs and add your comments there about any essentials that aren't covered.
Listed by article:
These are already deep in review:

PR coming soon (today/tomorrow) - I've checked these and I think we've already covered everything, though our approach is a bit different:

  • Community-contributing
  • Contact

Changes planned, but only after everything else is merged - we'll make sure the proposed change is taken into account when we do this:

  • Index

No significant changes planned to this one:

  • Code-Style-Language_versions

@Supull

Supull commented Jun 22, 2026

Copy link
Copy Markdown
Author

Thanks for the context! Happy to close this in favour of your PRs. I'll leave comments on #6892 and #6901 if I spot anything missing.

@RachelPotts

Copy link
Copy Markdown

Thanks for the context! Happy to close this in favour of your PRs. I'll leave comments on #6892 and #6901 if I spot anything missing.

Ok! Maybe still helpful for you to make the change just on Code-Style-Language_versions as we won't be touching that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3di | Create and update community content

4 participants