Skip to content

Commit

Permalink
update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tttol committed Jul 6, 2024
1 parent a78050c commit 3483e84
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1,26 @@
TBD
# 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.

0 comments on commit 3483e84

Please sign in to comment.