From 69769e7b6302db6b8166545d13c7234790a1dac0 Mon Sep 17 00:00:00 2001
From: miyamo2 <miyamo2@outlook.com>
Date: Sun, 7 Jul 2024 14:51:28 +0900
Subject: [PATCH] added CONTRIBUTING.md

---
 CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++
 README.md       |  2 ++
 2 files changed, 34 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..3fa0f31
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -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
+```
diff --git a/README.md b/README.md
index e3cfd5a..aff1c82 100644
--- a/README.md
+++ b/README.md
@@ -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)