diff --git a/.github/workflows/staging.yml b/.github/workflows/staging.yml index 43dcd25..cd124dd 100644 --- a/.github/workflows/staging.yml +++ b/.github/workflows/staging.yml @@ -44,6 +44,6 @@ jobs: - name: Lint run: | cargo fmt --all -- --check - cargo clippy -- -D warnings + cargo clippy - name: Check - run: cargo check \ No newline at end of file + run: cargo check diff --git a/dev.md b/dev.md index 360e6c0..d1de695 100644 --- a/dev.md +++ b/dev.md @@ -1,12 +1,34 @@ -# Versioning rule +MDOJ is our two-person project, it unlikely to have entensive discussion with your, +but we welcome contribution. + +> [!TIP] +> Contribution is not hard, and people(two-person) are nice, so don't be afraid. + +# Priorities when making tradeoff + +1. Reasonable performance +2. Ease of Use +3. Code size + +# Pick an issue + +At the time of writing, our short-term goal is to make it usable for hosting small contest. + +Therefore, we prioritize [issue 16](https://github.com/mdcpp/mdoj/issues/16), +see issue label and pick issue with `P-High` or `good first issue`. + +# Branching rule + +We design branching rule ## Master branch Branch suitable for development -- application can run(standalone) -- test can fail terribly -- breaking change can only be push with pull request +- Without API change(see grpc crate), all branch should compile. +- Test can fail terribly. +- Breaking change should be created by pull request. +- Should format the code before push(clippy is not required). ## Staging branch @@ -14,7 +36,10 @@ Branch suitable for nightly deployment - deployment is ready(docker-compose can run) - most test pass -- document(how to config) should be synchronized with wiki +- Clippy warning should be take care + +> [!IMPORTANT] +> Please be sure API compatible before push master to staging ## Other branch