Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
39488: Update CONTRIBUTING.md r=knz a=knz

(the wiki links were broken/outdated)

Release note: none

Co-authored-by: Raphael 'kena' Poss <[email protected]>
  • Loading branch information
craig[bot] and knz committed Aug 10, 2019
2 parents 95968ee + 564422c commit 98d6832
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 10 deletions.
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,17 +98,17 @@ See our separate [style guide](docs/style.md) document.
When you're ready to commit, be sure to write a Good Commit Message™.

Our commit message guidelines are detailed here:
https://github.com/cockroachdb/cockroach/wiki/Git-Commit-Messages
https://wiki.crdb.io/wiki/spaces/CRDB/pages/73072807/Git+Commit+Messages

In summary (the wiki page details the rationales and provides further suggestions):
- Keep in mind who reads: think of the reviewer, think of the release notes
- [Separate subject from body with a blank line](https://github.com/cockroachdb/cockroach/wiki/Git-Commit-Messages#commit-title)
- [Use the body to explain *what* and *why* vs. *how*](https://github.com/cockroachdb/cockroach/wiki/Git-Commit-Messages#commit-description)
- [Prefix the subject line with the affected package/area](https://github.com/cockroachdb/cockroach/wiki/Git-Commit-Messages#commit-title)
- [Include a release note annotation](https://github.com/cockroachdb/cockroach/wiki/Git-Commit-Messages#release-notes), in the right position
- [Use the imperative mood in the subject line](https://github.com/cockroachdb/cockroach/wiki/Git-Commit-Messages#commit-title)
- [Keep the commit title concise but information-rich](https://github.com/cockroachdb/cockroach/wiki/Git-Commit-Messages#commit-title)
- [Wrap the body at some consistent width under 100 characters](https://github.com/cockroachdb/cockroach/wiki/Git-Commit-Messages#commit-description)
- [Separate subject from body with a blank line](https://wiki.crdb.io/wiki/spaces/CRDB/pages/73072807/Git+Commit+Messages)
- [Use the body to explain *what* and *why* vs. *how*](https://wiki.crdb.io/wiki/spaces/CRDB/pages/73072807/Git+Commit+Messages#GitCommitMessages-Commitdescription)
- [Prefix the subject line with the affected package/area](https://wiki.crdb.io/wiki/spaces/CRDB/pages/73072807/Git+Commit+Messages#GitCommitMessages-Committitle)
- [Include a release note annotation](https://wiki.crdb.io/wiki/spaces/CRDB/pages/73072807/Git+Commit+Messages#GitCommitMessages-Releasenotes), in the right position
- [Use the imperative mood in the subject line](https://wiki.crdb.io/wiki/spaces/CRDB/pages/73072807/Git+Commit+Messages#GitCommitMessages-Committitle)
- [Keep the commit title concise but information-rich](https://wiki.crdb.io/wiki/spaces/CRDB/pages/73072807/Git+Commit+Messages#GitCommitMessages-Committitle)
- [Wrap the body at some consistent width under 100 characters](https://wiki.crdb.io/wiki/spaces/CRDB/pages/73072807/Git+Commit+Messages#GitCommitMessages-Commitdescription)

## Code Review Workflow

Expand Down Expand Up @@ -194,7 +194,7 @@ In summary (the wiki page details the rationales and provides further suggestion
"merge skew". When you're ready to merge, add a comment to your PR of the
form `bors r+`. Craig (our Bors bot)
will run CI on your changes, and if it passes, merge them. For more
information, see [the wiki](https://github.com/cockroachdb/cockroach/wiki/Bors-merge-bot).
information, see [the wiki](https://wiki.crdb.io/wiki/spaces/CRDB/pages/73204099/Bors+Merge+Bot)
## Debugging
Expand All @@ -207,7 +207,7 @@ Peeking into a running cluster can be done in several ways:
what happens inside of `Node`/`Store`/`Replica` and the other inside
of the coordinator (`TxnCoordSender`).
- [pprof](https://golang.org/pkg/net/http/pprof/) gives us (among
other things) heap and cpu profiles; [this wiki page](https://github.com/cockroachdb/cockroach/wiki/pprof)
other things) heap and cpu profiles; [this wiki page](https://wiki.crdb.io/wiki/spaces/CRDB/pages/73203940/Profiling+CockroachDB)
gives an overview and walks you through using it to profile Cockroach.
[This golang blog post](http://blog.golang.org/profiling-go-programs)
explains it extremely well and [this one by Dmitry
Expand Down
4 changes: 4 additions & 0 deletions docs/first-pr.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This document is a long-winded guide to preparing and submitting your first
contribution to CockroachDB. It's primarily intended as required reading for new
Cockroach Labs engineers, but may prove useful to external contributors too.

It is also complementary to the public wiki page at https://wiki.crdb.io/wiki/spaces/CRDB/pages/73072641/How+to+submit+a+good+CockroachDB+PR

**Table of contents**
+ [The development cycle](#the-development-cycle)
+ [First things first](#first-things-first)
Expand Down Expand Up @@ -600,6 +602,7 @@ Here's a checklist of action items to keep you sane:
+ [ ] Push to a feature branch on your personal fork
+ [ ] Verify you've followed [CONTRIBUTING.md]
+ [ ] Verify you've followed [docs/style.md]
+ [ ] Verify you've read the [wiki page on PRs]
+ [ ] Ensure files you've added, if any, have a license block
+ [ ] Run make check
+ [ ] Split your change into logical commits with good messages
Expand Down Expand Up @@ -637,3 +640,4 @@ Here's a checklist of action items to keep you sane:
[by humans for humans]: https://mtlynch.io/human-code-reviews-1/
[minimally nice maintainer]: https://brson.github.io/2017/04/05/minimally-nice-maintainer
[Bors merge bot]: https://wiki.crdb.io/wiki/spaces/CRDB/pages/73204099/Bors+Merge+Bot
[wiki page on PRs]: https://wiki.crdb.io/wiki/spaces/CRDB/pages/73072641/How+to+submit+a+good+CockroachDB+PR

0 comments on commit 98d6832

Please sign in to comment.