Skip to content

Commit

Permalink
added CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
miyamo2 committed Jul 7, 2024
1 parent af64845 commit 69769e7
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
## Contributing

Thanks for your interest in contribute to dynmgrm!


### Getting Started

1. [Fork `miyamo2/dynmgrm`](https://github.com/miyamo2/dynmgrm/fork)

2. Clone your fork repository locally

```sh
git clone https://github.com/{YOUR_USERNAME}/dynmgrm.git
```
3. Check out to the working branch

```sh
git checkout -b cool_branch_name
```

### Unit Test

```sh
go test -v ./...
```

### Integration Test with DynamoDB Local

```sh
cd ./integrationtest
make test
```
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,8 @@ Feel free to open a PR or an Issue.

However, you must promise to follow our [Code of Conduct](https://github.com/miyamo2/dynmgrm/blob/main/CODE_OF_CONDUCT.md).

See [here](https://github.com/miyamo2/dynmgrm/blob/main/CONTRIBUTING.md) for more details on contributing.

## License

**dynmgrm** released under the [MIT License](https://github.com/miyamo2/dynmgrm/blob/main/LICENSE)
Expand Down

0 comments on commit 69769e7

Please sign in to comment.