ros2_documentation icon indicating copy to clipboard operation
ros2_documentation copied to clipboard

Enhance contribution setup docs with streamlined commands

Open Victor-Boyd opened this issue 2 years ago • 0 comments

As an individual contributor to this open-source project, I noticed an opportunity to enhance the contributor experience by simplifying the initial setup instructions within our documentation. This commit aims to lower the entry barrier for new contributors by providing a concise, all-in-one command sequence that facilitates the setup process.

Key Updates:

  • Introduced a command for cloning the repository, ensuring newcomers start off on the right foot without having to navigate through multiple setup steps.
  • Integrated the PATH environment variable update (~/.local/bin) within the setup commands to eliminate the need for manual configuration, making the environment preparation seamless.
  • Combined cloning, environment setup, and dependencies installation into a singular command. This change is designed to make the first-time setup as straightforward as possible, aligning with our project's goal of being accessible and welcoming to new contributors.

Rationale: The motivation behind these changes is to simplify the contribution process, making it more appealing and less daunting for individuals looking to contribute to our project. By streamlining the setup instructions, we hope to encourage a broader range of contributions and foster a more inclusive community.

Victor-Boyd avatar Feb 21 '24 10:02 Victor-Boyd