Skip to content

Add source control best practices guide#6917

Open
sirishapadmasekhar wants to merge 4 commits into
ros2:rollingfrom
sirishapadmasekhar:add-source-control-best-practices
Open

Add source control best practices guide#6917
sirishapadmasekhar wants to merge 4 commits into
ros2:rollingfrom
sirishapadmasekhar:add-source-control-best-practices

Conversation

@sirishapadmasekhar

@sirishapadmasekhar sirishapadmasekhar commented Jun 23, 2026

Copy link
Copy Markdown

Description

Adds a new Source Control Best Practices guide under the Contributing section.

The guide covers:

  • Avoiding generated workspace artifacts in commits
  • Editor-specific files
  • Using a global gitignore
  • Authentication and credential management references

Also adds the page to the Contributing documentation navigation.

AI Usage

ChatGPT was used to assist with reviewing and restructuring the documentation.

Fixes #6040

@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.

description looks good to me once the workflow is green. i would like to have 2nd approval before merge.

CC: @ahcorde @christophebedard @kscottz

Comment thread source/The-ROS2-Project/Contributing/Source-Control-Best-Practices.rst Outdated
@fujitatomoya

Copy link
Copy Markdown
Collaborator

i will start the workflow, so that you can see the failures by lines.

@fujitatomoya fujitatomoya added the backport-all backport at reviewers discretion; from rolling to all versions label Jun 23, 2026
@fujitatomoya

Copy link
Copy Markdown
Collaborator

@sirishapadmasekhar thanks for the PR, can you take a look at https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.html? the tests and checks can be done in your local environment, please make sure all tests are passing.

@sirishapadmasekhar

Copy link
Copy Markdown
Author

@fujitatomoya Thanks for the review. I updated the document to use one sentence per line and pushed the changes. I also ran the local documentation checks (doc8 and sphinx-lint), and both pass successfully.

@fujitatomoya

Copy link
Copy Markdown
Collaborator

@sirishapadmasekhar thanks for fixing. there is one thing to confirm since you did not use our pull request template, did you use any AI tools such as codex or claunde? if so, can you disclose that information?

Comment thread source/The-ROS2-Project/Contributing/Source-Control-Best-Practices.rst Outdated

@peci1 peci1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I've suggested a few improvements.

Apart from them, I have one more high-level observation: what about changing the structure like this?

  • intro
  • avoid committing generated and temporary files
    • sources of generated/temporary/backup files
      • colcon workspace artifacts
      • IDE configs
      • editor temporary/backup files
      • OS files (.DS_store)
    • gitignore placement options:
      • repo gitignore
      • global gitignore
  • credential helpers
  • developing on shared robots
  • additional resources

Comment thread source/The-ROS2-Project/Contributing/Source-Control-Best-Practices.rst Outdated
Comment thread source/The-ROS2-Project/Contributing/Source-Control-Best-Practices.rst Outdated
Comment thread source/The-ROS2-Project/Contributing/Source-Control-Best-Practices.rst Outdated
@sirishapadmasekhar sirishapadmasekhar force-pushed the add-source-control-best-practices branch from 308f76f to c228f68 Compare July 3, 2026 10:34
@sirishapadmasekhar

Copy link
Copy Markdown
Author

Thanks @fujitatomoya and @peci1 for the review and suggestions. I have addressed the requested changes, updated the document structure and sentence wrapping, verified that doc8 passes and make html builds successfully, and added the AI usage disclosure to the PR description.
Please let me know if there are any further changes needed.

@fujitatomoya

fujitatomoya commented Jul 5, 2026

Copy link
Copy Markdown
Collaborator

i would like to have 2nd approval on this before merge. please wait for a bit.

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

Labels

backport-all backport at reviewers discretion; from rolling to all versions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a short tutorial on correct setup of a global .gitignore

3 participants