Unverified Commit 570edc82 authored by Nugine's avatar Nugine
Browse files

readme: contributing

parent 06335246

CODE_OF_CONDUCT.md

0 → 100644
+9 −0
Original line number Diff line number Diff line 
# Code of Conduct



This project follows the [Rust Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct).



**ADDITIONAL**: DO NOT submit anything about real world politics.



For example, the political statements in the posts below will be rejected.

+ <https://blog.rust-lang.org/2020/06/04/Rust-1.44.0.html>

+ <https://blog.rust-lang.org/2022/11/03/Rust-1.65.0.html>

CONTRIBUTING.md

0 → 100644
+69 −0
Original line number Diff line number Diff line 
# Development Guide



Toolchain



+ [Rust 1.66.1 or newer](https://rustup.rs/)

+ [just](https://github.com/casey/just)



Get the source code



```bash

git clone https://github.com/Nugine/s3s.git

cd s3s

```



#### Run basic checks and tests



```bash

just dev

```



#### Run the codegen



```bash

just download-model

just codegen

```



It should change nothing if you are running the latest code.



#### Play the test server



Install `s3s-fs`



```bash

just install

```



Run `s3s-fs` with example configuration



```bash

./scripts/s3s-fs.sh

```



```

Access Key: AKEXAMPLES3S

Secret Key: SKEXAMPLES3S

```



Then you can explore it with your favorite S3 client!



#### Run E2E tests



Install `s3s-proxy`



```bash

just install

```



Run the combined server and save logs



```bash

./scripts/s3s-proxy.sh | tee target/s3s-proxy.ansi

```



Open a new terminal, then run the test suite



```bash

./scripts/mint.sh

```

README.md

+3 −68
Original line number Diff line number Diff line
@@ -37,72 +37,7 @@ The diagram above shows how `s3s` works. 


The data types, serialization and deserialization are generated from the smithy model in [aws-sdk-rust](https://github.com/awslabs/aws-sdk-rust) repository, with some manual hacks.



## Develop

## Contributing



Toolchain



+ [Rust 1.66.1 or newer](https://rustup.rs/)

+ [just](https://github.com/casey/just)



Get the source code



```bash

git clone https://github.com/Nugine/s3s.git

cd s3s

```



#### Run basic checks and tests



```bash

just dev

```



#### Run the codegen



```bash

just download-model

just codegen

```



It should change nothing if you are running the latest code.



#### Play the test server



Install `s3s-fs`



```bash

just install

```



Run `s3s-fs` with example configuration



```bash

./scripts/s3s-fs.sh

```



```

Access Key: AKEXAMPLES3S

Secret Key: SKEXAMPLES3S

```



Then you can explore it with your favorite S3 client!



#### Run E2E tests



Install `s3s-proxy`



```bash

just install

```



Run the combined server and save logs



```bash

./scripts/s3s-proxy.sh | tee target/s3s-proxy.ansi

```



Open a new terminal, then run the test suite



```bash

./scripts/mint.sh

```
 
+ [Development Guide](./CONTRIBUTING.md)

+ [Code of Conduct](./CODE_OF_CONDUCT.md)