Skip to content

Commit

Permalink
ci(ci): make staging check ignore clippy warning, update dev.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Eason0729 committed Aug 28, 2024
1 parent eff5119 commit 47f9e46
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 7 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/staging.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ jobs:
- name: Lint
run: |
cargo fmt --all -- --check
cargo clippy -- -D warnings
cargo clippy
- name: Check
run: cargo check
run: cargo check
35 changes: 30 additions & 5 deletions dev.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,45 @@
# 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

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

Expand Down

0 comments on commit 47f9e46

Please sign in to comment.