Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance contribution setup docs with streamlined commands #4181

Open
wants to merge 1 commit into
base: rolling
Choose a base branch
from

Commits on Feb 21, 2024

  1. Enhance contribution setup docs with streamlined commands

    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.
    
    Signed-off-by: Victor Boyd <[email protected]>
    Victor-Boyd authored Feb 21, 2024
    Configuration menu
    Copy the full SHA
    0cbac1c View commit details
    Browse the repository at this point in the history