You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-11Lines changed: 10 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,13 +22,11 @@ Specifically for code in this repo:
22
22
23
23
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.
24
24
25
-
2. Anchor programs should be in directory `anchor`, programs written for Solana Native should be in directory `native`, TypeScript in `posidon` and Python in `seahorse`.
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
26
27
-
3. Tests for Solana native, Steel and Anchor programs should be written with [ts-mocha](https://github.com/piotrwitek/ts-mocha).
27
+
3. Tests for Solana native programs, steel framework programs, and Anchor should be written with [solana-bankrun](https://kevinheavey.github.io/solana-bankrun)
28
28
29
-
4. Tests for Solana native programs and steel framework programs should be written with [solana-bankrun](https://kevinheavey.github.io/solana-bankrun)
30
-
31
-
5. For Solana native programs and Steel framework programs ensure adding these mandatory pnpm run scripts to your `package.json` file for successful CI/CD builds:
29
+
4. For Solana native programs and Steel framework programs ensure adding these mandatory pnpm run scripts to your `package.json` file for successful CI/CD builds:
32
30
33
31
```json
34
32
"scripts": {
@@ -39,19 +37,20 @@ Specifically for code in this repo:
39
37
},
40
38
```
41
39
42
-
6. 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)
40
+
5. 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)
43
41
44
-
7. TypeScript, JavaScript and JSON files are formatted and linted using
42
+
6. TypeScript, JavaScript and JSON files are formatted and linted using
45
43
[Biome](https://biomejs.dev/). Execute the following command to format and lint your code at the root of this project before submitting a pull request:
46
44
47
-
8. Some projects can be ignored from the building and testing process by adding the project name to the `.ghaignore` file.
48
-
When removing or updating an example, please ensure that the example is removed from the `.ghaignore` file
49
-
and there's a change in that example's directory.
50
-
51
45
```bash
52
46
pnpm check:fix
53
47
```
54
48
49
+
7. Some projects can be ignored from the building and testing process by adding the project name to the `.gitignore` file.
50
+
When removing or updating an example, please ensure that the example is removed from the `.gitignore` file
51
+
and there's a change in that example's directory.
52
+
53
+
55
54
## Code of Conduct
56
55
57
56
We are committed to providing a friendly, safe, and welcoming environment for all contributors, regardless of their background, experience level, or personal characteristics. As a contributor, you are expected to:
0 commit comments