-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
lint CONTRIBUTING.md and README.md (#1123)
- Loading branch information
Showing
2 changed files
with
37 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,7 +16,7 @@ you to accept the CLA when you open your pull request. | |
|
||
[Fork][fork], then clone the repository: | ||
|
||
``` | ||
```bash | ||
mkdir -p $GOPATH/src/go.uber.org | ||
cd $GOPATH/src/go.uber.org | ||
git clone [email protected]:your_github_username/zap.git | ||
|
@@ -27,7 +27,7 @@ git fetch upstream | |
|
||
Make sure that the tests and the linters pass: | ||
|
||
``` | ||
```bash | ||
make test | ||
make lint | ||
``` | ||
|
@@ -36,7 +36,7 @@ make lint | |
|
||
Start by creating a new branch for your changes: | ||
|
||
``` | ||
```bash | ||
cd $GOPATH/src/go.uber.org/zap | ||
git checkout master | ||
git fetch upstream | ||
|
@@ -47,22 +47,22 @@ git checkout -b cool_new_feature | |
Make your changes, then ensure that `make lint` and `make test` still pass. If | ||
you're satisfied with your changes, push them to your fork. | ||
|
||
``` | ||
```bash | ||
git push origin cool_new_feature | ||
``` | ||
|
||
Then use the GitHub UI to open a pull request. | ||
|
||
At this point, you're waiting on us to review your changes. We *try* to respond | ||
At this point, you're waiting on us to review your changes. We _try_ to respond | ||
to issues and pull requests within a few business days, and we may suggest some | ||
improvements or alternatives. Once your changes are approved, one of the | ||
project maintainers will merge them. | ||
|
||
We're much more likely to approve your changes if you: | ||
|
||
* Add tests for new functionality. | ||
* Write a [good commit message][commit-message]. | ||
* Maintain backward compatibility. | ||
- Add tests for new functionality. | ||
- Write a [good commit message][commit-message]. | ||
- Maintain backward compatibility. | ||
|
||
[fork]: https://github.com/uber-go/zap/fork | ||
[open-issue]: https://github.com/uber-go/zap/issues/new | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters