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

Minor edits and updates for clarity and deduplication #11

Merged
merged 4 commits into from
Oct 10, 2024
Merged

Conversation

keithchev
Copy link
Member

@keithchev keithchev commented Oct 4, 2024

This PR makes a few minor changes:

  • it revises the source control standards document to bring it up to date with current practices and reduce duplication with other documentation (for context, this document was originally written by Mert two years ago and had not been updated since).
  • it adds more details about sensitive information to the standards for public repos.
  • it renames the filenames of the guides and standards documents for clarity.

Note to reviewers: the changes to the source control standards document were substantial enough that it is rendered as a new file in the PR diff. Most of this document is unchanged or lightly edited, so please don't review too closely.

@keithchev keithchev marked this pull request as ready for review October 9, 2024 01:11
@keithchev keithchev changed the title Minor edits for clarity Minor edits and updates for clarity and deduplication Oct 9, 2024
taylorreiter
taylorreiter previously approved these changes Oct 9, 2024
Copy link
Member

@taylorreiter taylorreiter left a comment

Choose a reason for hiding this comment

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

Looks good to me!

guides-and-standards/standards--source-control.md Outdated Show resolved Hide resolved
guides-and-standards/standards--source-control.md Outdated Show resolved Hide resolved
guides-and-standards/standards--source-control.md Outdated Show resolved Hide resolved
guides-and-standards/standards--source-control.md Outdated Show resolved Hide resolved
guides-and-standards/standards--source-control.md Outdated Show resolved Hide resolved
ekiefl
ekiefl previously approved these changes Oct 10, 2024
Copy link

@ekiefl ekiefl left a comment

Choose a reason for hiding this comment

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

At my last company we called this sort of work "noble", and made sure to give praise whenever it was done. So thanks for this noble work, @keithchev. It looks great.

guides-and-standards/standards--source-control.md Outdated Show resolved Hide resolved
guides-and-standards/standards--source-control.md Outdated Show resolved Hide resolved
@keithchev keithchev dismissed stale reviews from ekiefl and taylorreiter via 5a9e902 October 10, 2024 01:05
@keithchev keithchev merged commit 3a4b319 into main Oct 10, 2024
1 check passed
@keithchev keithchev deleted the kcc/edits branch October 10, 2024 01:07
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.

3 participants