From 3483e845d4ec2e42d146c737f43a71d906528ce9 Mon Sep 17 00:00:00 2001 From: t-takahashi Date: Sat, 6 Jul 2024 19:29:31 +0900 Subject: [PATCH] update CONTRIBUTING.md --- CONTRIBUTING.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2fd9f95..846195b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1 +1,26 @@ -TBD \ No newline at end of file +# Contributing Guidelines + +Thank you for your interest in contributing to MOS3. This is a Contribution guidelines. +Please read through this document before submitting any issues or pull requests. + +## Contributing via Pull Requests + +To send us a pull request, please: + +1. Fork the repository. +2. Modify the source code. +3. Ensure local tests pass. +4. Commit to your fork. +5. Send us a pull request. + +## Set up your local development environment +To set up MOS3 in your local environment, please: + +1. Fork this repository, and clone source code using `git clone` +2. go to mos3 directory using `cd mos3` +3. Run the follwing command `go run main.go` +4. Then access http://localhost:3333/s3 + +## Licensing + +See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. \ No newline at end of file