Skip to content

Commit

Permalink
Update templated README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
anitarua authored and Momento GitHub Actions Bot committed Jul 3, 2024
1 parent 330524f commit 8667615
Showing 1 changed file with 25 additions and 13 deletions.
38 changes: 25 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<img src="https://docs.momentohq.com/img/momento-logo-forest.svg" alt="logo" width="400"/>

[![project status](https://momentohq.github.io/standards-and-practices/badges/project-status-official.svg)](https://github.com/momentohq/standards-and-practices/blob/main/docs/momento-on-github.md)
[![project stability](https://momentohq.github.io/standards-and-practices/badges/project-stability-beta.svg)](https://github.com/momentohq/standards-and-practices/blob/main/docs/momento-on-github.md)


# Welcome to the Momento Go-Redis contributing guide :wave:

Thank you for taking your time to contribute to our Momento `go-redis` wrapper!
Expand All @@ -7,29 +13,31 @@ This guide will provide you information to start your own development and testin
Happy coding :dancer:
<br/>

## Submitting

If you've found a bug or have a suggestion, please [open an issue in our project](https://github.com/momentohq/terraform-provider-momento/issues).

If you want to submit a change, please [submit a pull request to our project](https://github.com/momentohq/terraform-provider-momento/pulls). Use the normal [Github pull request process](https://docs.github.com/en/pull-requests).

## Requirements :coffee:

- Go 1.18 or above is required https://go.dev/doc/install
- [Go 1.18 or above](https://go.dev/doc/install) is required
- A Momento API key is required, you can generate one using the [Momento Console](https://console.gomomento.com)

<br/>
## Developing :computer:

## Build :computer:
### Build

```
```bash
make build
```

<br/>

## Formatting and Tidy :flashlight:
### Formatting and Tidy :flashlight:

```
```bash
make lint
```

<br/>

## Tests :zap:

### Run integration tests against Momento
Expand All @@ -38,17 +46,18 @@ make lint
export TEST_AUTH_TOKEN=<YOUR_AUTH_TOKEN>
make test-momento
```

### Run integration tests against Redis

First run Redis either natively, run Redis in a Docker container, or do your development in a devcontainer. Here is an example of running Redis in a Docker container:

```
```bash
docker run -it -p 6379:6379 redis
```

Then run the tests

```
```bash
make test-redis
```

Expand All @@ -63,4 +72,7 @@ This will run both the integration tests against Momento and Redis. As above, we
```bash
export TEST_AUTH_TOKEN=<YOUR_AUTH_TOKEN>
make test
```
```

----------------------------------------------------------------------------------------
For more info, visit our website at [https://gomomento.com](https://gomomento.com)!

0 comments on commit 8667615

Please sign in to comment.