Skip to content

📖 Review and update CONTRIBUTING.md - #4002

Merged
spencerschrock merged 10 commits into
ossf:mainfrom
spencerschrock:contributing-md-review
Apr 4, 2024
Merged

📖 Review and update CONTRIBUTING.md#4002
spencerschrock merged 10 commits into
ossf:mainfrom
spencerschrock:contributing-md-review

Conversation

@spencerschrock

Copy link
Copy Markdown
Member

What kind of change does this PR introduce?

doc update

What is the current behavior?

The doc has gotten stale

What is the new behavior (if this is a feature change)?**

  • Made some things more prominent (DCO has been a problem for some contributors in the past)
  • Updated needed tool list
  • Recommend people don't force push after reviews
  • fix the make command table
  • General cleanup / rephrasing
  • Tests for the changes have been added (for bug fixes/features)

Which issue(s) this PR fixes

NONE

Special notes for your reviewer

Does this PR introduce a user-facing change?

For user-facing changes, please add a concise, human-readable release note to
the release-note

(In particular, describe what changes users might need to make in their
application as a result of this pull request.)


Signed-off-by: Spencer Schrock <sschrock@google.com>
Signed-off-by: Spencer Schrock <sschrock@google.com>
Signed-off-by: Spencer Schrock <sschrock@google.com>
GO111MODULE is no longer used as of Go 1.17.
GOPATH is still used for other purposes, but not in 'development mode'.
https://go.dev/wiki/GOPATH

Signed-off-by: Spencer Schrock <sschrock@google.com>
Signed-off-by: Spencer Schrock <sschrock@google.com>
I don't think this is one of the top things we should be displaying to someone

Signed-off-by: Spencer Schrock <sschrock@google.com>
Signed-off-by: Spencer Schrock <sschrock@google.com>
Signed-off-by: Spencer Schrock <sschrock@google.com>
Signed-off-by: Spencer Schrock <sschrock@google.com>
the comment style was wrong and the $ was interpretted as a command.

Signed-off-by: Spencer Schrock <sschrock@google.com>
@spencerschrock
spencerschrock requested review from a team, laurentsimon and raghavkaul and removed request for a team April 4, 2024 17:18
@codecov

codecov Bot commented Apr 4, 2024

Copy link
Copy Markdown

Codecov Report

Merging #4002 (0dca25e) into main (605feb7) will decrease coverage by 4.54%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4002      +/-   ##
==========================================
- Coverage   74.94%   70.41%   -4.54%     
==========================================
  Files         223      223              
  Lines       16046    16046              
==========================================
- Hits        12026    11298     -728     
- Misses       3253     4028     +775     
+ Partials      767      720      -47     

@spencerschrock
spencerschrock merged commit aeaee60 into ossf:main Apr 4, 2024
@spencerschrock
spencerschrock deleted the contributing-md-review branch April 4, 2024 19:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants