From 2457477270e6aef3f164f19a85555e52081ced78 Mon Sep 17 00:00:00 2001 From: Taylor Blau Date: Wed, 17 Oct 2018 10:51:58 -0700 Subject: [PATCH] CONTRIBUTING.md: use 1-based indices for numbered lists We use the Markdown trick that the same number over and over again produces a list of numbers incrementing starting at that base. This is good, since it reduces the diff later on should the list ordering change, grow new elements, etc. But it is not desirable to start the list at zero. Let's instead increment the list starting at 1, that way we get lists of the form (1), (2), (3), instead of (0), (1), (2). --- CONTRIBUTING.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 75ec05b8..7b20f9e9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,13 +49,13 @@ In general, contributors should develop on branches based off of `master` and pu ## Submitting a pull request -0. [Fork][] and clone the repository -0. Configure and install the dependencies: `make` -0. Make sure the tests pass on your machine: `make test` -0. Create a new branch based on `master`: `git checkout -b master` -0. Make your change, add tests, and make sure the tests still pass -0. Push to your fork and [submit a pull request][pr] from your branch to `master` -0. Pat yourself on the back and wait for your pull request to be reviewed +1. [Fork][] and clone the repository +1. Configure and install the dependencies: `make` +1. Make sure the tests pass on your machine: `make test` +1. Create a new branch based on `master`: `git checkout -b master` +1. Make your change, add tests, and make sure the tests still pass +1. Push to your fork and [submit a pull request][pr] from your branch to `master` +1. Pat yourself on the back and wait for your pull request to be reviewed Here are a few things you can do that will increase the likelihood of your pull request being accepted: @@ -109,10 +109,10 @@ tests: ## Updating 3rd party packages -0. Update `go.mod`. -0. Run `make vendor` to update the code in the `vendor` directory. -0. Commit the change. Git LFS vendors the full source code in the repository. -0. Submit a pull request. +1. Update `go.mod`. +1. Run `make vendor` to update the code in the `vendor` directory. +1. Commit the change. Git LFS vendors the full source code in the repository. +1. Submit a pull request. ## Releasing