Shift3 / standards-and-practices

Standards and Practices for Bitwise Industries
https://shift3.github.io/standards-and-practices/
63 stars 41 forks source link

docs(README.md): adds git config section #381

Closed ghost closed 1 year ago

ghost commented 1 year ago

Changes

  1. This section adds information for configuring git config on the root README.md file.

Purpose

Currently, our standards and practices does not include setting up git config #380 .

Approach

This added section will help new hires and or apprentices, setup their Github account with their work email and configure their Git with the correct Github account instead of their personal account.

Pre-Testing TODOs

None

Testing Steps

None

Learning

During this process, new hires and or apprentices will learn how to set their git user name and git user email.

To set your global username/email configuration

To set repository-specific username/email configuration

Closes #380

michaelachrisco commented 1 year ago

@jthieu-alphaworks Thanks for taking a look and adding to our Standards! One thing before we start:

Always assign pr-team to your PRs, per our code review process. Assign your PRs to @Shift3/pr-team in addition to the main devs on this project. This will automatically grab three developers from the PR team and assign them to perform a review. This will help to get a quicker turnaround on your reviews, and will also help this project to get reviews and feedback from team members with different perspectives and skill levels.

Example: https://github.com/Shift3/bitwiseindustries.com/pull/110

ghost commented 1 year ago

I am not sure why the settings icon is not appearing on my end to add the @Shift3/pr-team.

docs(README md)_ adds git config section by jthieu-alphaworks · Pull Request #381 · Shift3_standards-and-practices - Google Chrome 1_24_2023 4_42_25 PM

https://github.com/Shift3/bitwiseindustries.com/pull/110 is returning 404

michaelachrisco commented 1 year ago

jthieu-alphaworks I just did some digging, its because the PR came from outside the org. NVM dont worry about the PR Team for now. I went ahead and added them myself so we can get this PR rolling. Ill take a look sometime today.