Skip to content

Commit

Permalink
Update README.md and CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Change-Id: Ie8aa96700a36fee84e7008e8da889033b526b137
  • Loading branch information
skriptble committed Feb 12, 2018
1 parent bfa049c commit b06d21d
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 18 deletions.
36 changes: 22 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,36 @@

Thank you for your interest in contributing to the MongoDB Go driver.

We are building this software together and strongly encourage contributions from the community that are within the guidelines set forth
below.
We are building this software together and strongly encourage contributions from the community that are within the guidelines set forth
below.

## Bug Fixes and New Features

Before starting to write code, look for existing [tickets](https://jira.mongodb.org/browse/GODRIVER) or
[create one](https://jira.mongodb.org/secure/CreateIssue!default.jspa) for your bug, issue, or feature request. This helps the community
Before starting to write code, look for existing [tickets](https://jira.mongodb.org/browse/GODRIVER) or
[create one](https://jira.mongodb.org/secure/CreateIssue!default.jspa) for your bug, issue, or feature request. This helps the community
avoid working on something that might not be of interest or which has already been addressed.

## Pull Requests
## Pull Requests & Patches

Pull requests should generally be made against the master (default) branch and include relevant tests, if applicable.
The Go Driver team is experimenting with GerritHub for contributions. GerritHub uses GitHub for authentication and uses a patch based
workflow. Since GerritHub supports importing of Pull Requests we will also accept Pull Requests, but Code Review will be done in
GerritHub.

Code should compile and tests should pass under all go versions which the driver currently supports. Currently the driver
supports a minimum version of go 1.7. Please run 'make' to confirm. By default, running the tests requires that you started a
mongod server on localhost, listening on the default port. At minimum, please test against the latest release version of the MongoDB
server.
Patches should generally be made against the master (default) branch and include relevant tests, if applicable.

If any tests do not pass, or relevant tests are not included, the
pull request will not be considered.
Code should compile and tests should pass under all go versions which the driver currently supports. Currently the driver
supports a minimum version of go 1.7. Please ensure the following tools have been run on the code: gofmt, golint, errcheck,
go test (with coverage and with the race detector), and go vet. For convenience, you can run 'make' to run all these tools.
**By default, running the tests requires that you have a mongod server running on localhost, listening on the default port.**
At minimum, please test against the latest release version of the MongoDB server.

If any tests do not pass, or relevant tests are not included, the patch will not be considered.

If you are working on a bug or feature listed in Jira, please include the ticket number prefixed with GODRIVER in the commit,
e.g. GODRIVER-123. For the patch commit message itself, please follow the [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/) guide.

## Talk To Us

If you want to work on something or have questions / complaints please reach out to us by creating a Question issue at
(https://jira.mongodb.org/secure/CreateIssue!default.jspa).
If you want to work on the driver, write documentation, or have questions/complaints, please reach out to use either via
the [mongo-go-driver Google Group](https://groups.google.com/forum/#!forum/mongodb-go-driver) or by creating a Question
issue at (https://jira.mongodb.org/secure/CreateIssue!default.jspa).
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# mongo-go-driver

MongoDB Driver for golang.
MongoDB Driver for Go.

-------------------------
- [Bugs/Feature Reporting](#bugs-feature-reporting)
Expand All @@ -16,10 +16,10 @@ New Features and bugs can be reported on jira: https://jira.mongodb.org/browse/G
-------------------------
## Testing / Development

To run driver tests, make sure a MongoDB server instance is running at localhost:27017. Using make, you can run `make` (on windows, run `nmake`).
This will generate tests from the specifications, run coverage, run go-lint, run go-vet, and build the examples.
To run driver tests, make sure a MongoDB server instance is running at localhost:27017. Using make, you can run `make` (on windows, run `nmake`).
This will run coverage, run go-lint, run go-vet, and build the examples.

The MongoDB Go Driver is not feature complete, so any help is appreciated. Check out the [project page](https://jira.mongodb.org/browse/GODRIVER)
The MongoDB Go Driver is not feature complete, so any help is appreciated. Check out the [project page](https://jira.mongodb.org/browse/GODRIVER)
for tickets that need completing. See our [contribution guidelines](CONTRIBUTING.md) for details.

-------------------------
Expand Down

0 comments on commit b06d21d

Please sign in to comment.