|
| 1 | +# Contributing to cobra2snooty |
| 2 | + |
| 3 | +Thanks for your interest in contributing to `cobra2snooty`, |
| 4 | +The following is a set of guidelines for contributing to this project. |
| 5 | +These are just guidelines, not rules. Use your best judgment, and |
| 6 | +feel free to propose changes to this document in a pull request. |
| 7 | + |
| 8 | +Note that `cobra2snooty` is an evolving project, so expect things to change over |
| 9 | +time as the team learns, listens and refines how we work with the community. |
| 10 | + |
| 11 | +## What should I know before I get started? |
| 12 | + |
| 13 | +### Code of Conduct |
| 14 | + |
| 15 | +This project has adopted the [MongoDB Code of Conduct](https://www.mongodb.com/community-code-of-conduct). |
| 16 | +By participating, you are expected to uphold this code. |
| 17 | +If you see any violations of the above or have any other concerns or questions please contact us |
| 18 | +using the following email alias: [[email protected]](mailto:[email protected]). |
| 19 | + |
| 20 | +## How Can I Contribute? |
| 21 | + |
| 22 | +### Development setup |
| 23 | + |
| 24 | +#### Prerequisite Tools |
| 25 | +- [Git](https://git-scm.com/) |
| 26 | +- [Go (at least Go 1.18)](https://golang.org/dl/) |
| 27 | + |
| 28 | +#### Environment |
| 29 | +- Fork the repository. |
| 30 | +- Clone your forked repository locally. |
| 31 | +- We use Go Modules to manage dependencies, so you can develop outside your `$GOPATH`. |
| 32 | +- We use [golangci-lint](https://github.com/golangci/golangci-lint) to lint our code, you can install it locally via `make setup`. |
| 33 | +- For pull requests to be accepted, contributors must sign [MongoDB CLA](https://www.mongodb.com/legal/contributor-agreement). |
| 34 | + |
| 35 | +### Building and testing |
| 36 | + |
| 37 | +The following is a short list of commands that can be run in the root of the project directory: |
| 38 | + |
| 39 | +- Run `make test` to run all unit tests. |
| 40 | +- Run `make lint` to validate against our linting rules. |
| 41 | + |
| 42 | +We provide a git pre-commit hook to format and check the code, to install it run `make link-git-hooks` |
| 43 | + |
| 44 | +## Maintainer's Guide |
| 45 | + |
| 46 | +Reviewers, please ensure that the CLA has been signed by referring to [the contributors tool](https://contributors.corp.mongodb.com/) (internal link). |
0 commit comments