Skip to content

Commit ebd36df

Browse files
committed
Improve contributing
1 parent 3bc30ae commit ebd36df

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,9 @@ Specifically for code in this repo:
2222

2323
1. Use pnpm as the default package manager for the project. You can [install pnpm by following the instructions](https://pnpm.io/installation). Commit `pnpm-lock.yaml` to the repository.
2424

25-
2. Anchor programs should be in directory `anchor`, programs written for Solana Native should be in directory `native`, TypeScript in `poseidon` and Python in `seahorse`.
26-
- Project path structure: `/program-examples/category/example-name/steel`
25+
2. Solana Programs written for Anchor framework should be in directory (`anchor`)[https://www.anchor-lang.com], Solana Native in (`native`)[https://solana.com/developers/guides/getstarted/intro-to-native-rust], Steel Framework in (`steel`)[https://github.com/regolith-labs/steel], TypeScript in (`poseidon`)[https://github.com/Turbin3/poseidon], respectively.
26+
- Project path structure: `/program-examples/category/example-name/<framework_name>`
27+
- Project path structure example for anchor: `/program-examples/category/example-name/anchor`
2728

2829
3. Tests for Solana native programs, steel framework programs, and Anchor should be written with [solana-bankrun](https://kevinheavey.github.io/solana-bankrun)
2930

@@ -67,6 +68,13 @@ Specifically for code in this repo:
6768

6869
Alternatively, You can add `steel test` and `steel build` as commands according to your project.
6970

71+
"scripts": {
72+
"test": "steel test",
73+
"build-and-test": "steel build && steel test",
74+
"build": "steel build",
75+
"deploy": "solana program deploy ./program/target/so/program.so"
76+
},
77+
7078
7. Test command for Anchor should execute `pnpm test` instead of `yarn run test` for anchor programs. Replace `yarn` with `pnpm` in `[script]` table inside [Anchor.toml file.](https://www.anchor-lang.com/docs/manifest#scripts-required-for-testing)
7179

7280
8. TypeScript, JavaScript and JSON files are formatted and linted using

0 commit comments

Comments
 (0)