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

1624-vrms onboarding - Suggested updates to Contributing.md #1631

Merged
merged 3 commits into from
Apr 30, 2024

Conversation

lcchrty
Copy link
Member

@lcchrty lcchrty commented Apr 24, 2024

Suggested updates to Contributing.md #1624 -VRMS-Onboarding

What changes did you make and why did you make them?

  • Formatting changes to onboarding sections to show the sequencing of steps
  • Reordering some language so it was clear what was a note and what was an instruction
  • added formatting to the fork URL to make it clearer where to insert the user's GitHub username
  • added an example to help identify the remote link in the terminal when running the git remote command
  • Question: I added a question about clearer instructions for the environment variables. It looks like there are two sets for the client .env file. Can we provide some guidance on when to use which set?

Screenshots of Proposed Changes Of The Website (if any, please do not screen shot code changes)

Visuals before changes are applied

image

Visuals after changes are applied

image

Copy link

Want to review this pull request? Take a look at this documentation for a step by step guide!

From your project repository, check out a new branch and test the changes.

git checkout -b lcchrty-1624-vrms-onboarding development
git pull https://github.com/lcchrty/VRMS.git 1624-vrms-onboarding

@lcchrty lcchrty changed the title 1624-vrms onboarding 1624-vrms onboarding - Suggested updates to Contributing.md Apr 24, 2024
Copy link
Member

@trillium trillium left a comment

Choose a reason for hiding this comment

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

Will accept this once diff block is removed :)

CONTRIBUTING.md Show resolved Hide resolved
resolved environment variables question by updating elsewhere
Copy link
Member

@trillium trillium left a comment

Choose a reason for hiding this comment

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

🚀

@trillium trillium merged commit 2647937 into hackforla:development Apr 30, 2024
1 check passed
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.

2 participants