Skip to content

Commit 0852efc

Browse files
authored
docs: add a CONTRIBUTING and RELEASING docs (#35)
* docs: add a CONTRIBUTING and RELEASING docs * Update pull_request_template.md
1 parent c1a866c commit 0852efc

File tree

3 files changed

+56
-2
lines changed

3 files changed

+56
-2
lines changed

.github/pull_request_template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!--
2-
Thanks for contributing to MongoDB Ops Manager Go Client!
2+
Thanks for contributing to cobra2snooty
33
4-
Before you submit your pull request, please be sure that you've reviewed our contributing guidelines: https://github.com/mongodb/go-client-mongodb-ops-manager/blob/master/CONTRIBUTING.md
4+
Before you submit your pull request, please be sure that you've reviewed our contributing guidelines: https://github.com/mongodb-labs/cobra2snooty/blob/master/CONTRIBUTING.md
55
66
Please fill out the information below to help speed the review along, and hopefully
77
the merge of your pull request!

CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
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).

RELEASING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Releasing
2+
3+
## Tag and Release
4+
5+
- Follow https://semver.org/ for release numbers
6+
- Tag and release
7+
- Feel free to use the [GitHub GUI](https://github.com/mongodb-labs/cobra2snooty/releases/new)
8+

0 commit comments

Comments
 (0)