Skip to content

Commit f2a0843

Browse files
authored
chore: Update Ninja Contributing (#1241)
1 parent 7ce8869 commit f2a0843

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

NINJA_CONTRIBUTING.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ Ideally, your project should have a frontend and backend.
1313
* `/hosting` for a frontend-only project
1414

1515
### Compilation requirements
16-
* Make sure the project compiles and runs with `dfx deploy` inside the latest `ghcr.io/dfinity/icp-dev-env-slim` container.
17-
* Make sure `npm run dev` works and the canister can be called through the browser (if applicable).
16+
* Make sure the project compiles and runs with `dfx deploy` inside the `ghcr.io/dfinity/icp-dev-env-slim` container.
17+
* Make sure there are no custom scripts for building or running the project, as ICP Ninja has no terminal!
18+
* Make sure `npm run dev` works and the canister can be called through the browser (if applicable, this is if users download the project and run it locally).
1819
* Make sure II login works (if applicable).
1920
* If you use Rust, make sure the project has `ic_cdk::export_candid!();` in the `lib.rs` file, such that the Candid interface can be auto derived.
2021
* If you use Motoko, use Mops as the package manager.
@@ -25,14 +26,15 @@ Ideally, your project should have a frontend and backend.
2526
* Tailwind CSS for styling (recommended), or plain CSS
2627

2728
## Preparing the PR
28-
1. Add your project in the `CODEOWNERS` file, with your team plus `@dfinity/ninja-devs` as reviewers.
29+
1. Add your project in the `CODEOWNERS` file, with your team as codeowner.
2930
2. Add your project to the matrix in `.github/workflows/ninja_pr_checks.yml` to run PR tests.
3031
3. Add a `README.md` file, copy the `BUILD.md` and `devcontainer.json` files.
32+
4. Request review from the `@dfinity/ninja-devs` team if it is not added automatically.
3133

32-
## Submit a PR to ICP Ninja
34+
## Submit a PR to the ICP Ninja repo
3335
1. Add your newly added project to `frontend/public/projects.json`
3436
2. Bump the commit hash in `submodules/examples` to a commit hash after your PR has been merged into the examples repo.
35-
* ask the Ninja team or AI to give you a beautiful image for your project
37+
3. Ask the Ninja team or AI to give you a beautiful image for your project
3638

3739
## Templates
3840

0 commit comments

Comments
 (0)