Skip to content

docs: Slight tweaks to contributing guidelines #133

New issue

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

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

Already on GitHub? # to your account

Merged
merged 1 commit into from
Jun 27, 2024

Conversation

jmgate
Copy link
Collaborator

@jmgate jmgate commented Jun 27, 2024

Just some minor tweaks to the contributing guidelines I ran across when preparing a new repository for open sourcing.

  • The test file naming is handled behind the scenes by another pre-commit check.
  • No need to recommend the GitLab extension, since this is now on GitHub.
  • No need to worry about external vs internal since this is hosted externally.
  • Remove specific git commands—if you need to force-push/pull, you should be able to figure it out.

@jmgate jmgate self-assigned this Jun 27, 2024
@jmgate
Copy link
Collaborator Author

jmgate commented Jun 27, 2024

@william76, @GhostofGoes, either of you want to take a quick look and approve?

Copy link

codecov bot commented Jun 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.04%. Comparing base (3c673f4) to head (6e2ddc9).
Report is 138 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #133   +/-   ##
=======================================
  Coverage   94.04%   94.04%           
=======================================
  Files           2        2           
  Lines         168      168           
  Branches       43       43           
=======================================
  Hits          158      158           
  Misses          4        4           
  Partials        6        6           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@GhostofGoes
Copy link
Collaborator

GhostofGoes commented Jun 27, 2024

IMO, including the commands is helpful especially for new contributors, but I could go either way on this. Otherwise, LGTM.

@jmgate jmgate merged commit d2f569e into master Jun 27, 2024
13 checks passed
@jmgate jmgate deleted the tweak-contributing-guidelines branch June 27, 2024 16:04
@jmgate
Copy link
Collaborator Author

jmgate commented Jun 27, 2024

Yeah, I wound up taking it out because the syntax has changed over time (e.g., git push --force vs git push remote +branch vs git push --force-with-lease, etc.), and I figure I don't want to keep updating the docs with improvements to git's CLI. Thanks for the review 😁

Copy link
Collaborator

@william76 william76 left a comment

Choose a reason for hiding this comment

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

LGTM

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants