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
+7-3
Original file line number
Diff line number
Diff line change
@@ -1,23 +1,26 @@
1
1
# Contribution Guidelines
2
+
2
3
Thank you for considering contributing to the Solana Program Examples repository. We greatly appreciate your interest and efforts in helping us improve and expand this valuable resource for the Solana developer community.
3
4
4
5
We believe that a welcoming and inclusive environment fosters collaboration and encourages participation from developers of all backgrounds and skill levels.
5
6
6
7
To ensure a smooth and effective contribution process, please take a moment to review and follow the guidelines outlined below.
7
8
8
9
## How to Contribute
10
+
9
11
We welcome contributions in the form of code, documentation, bug reports, feature requests, and other forms of feedback. Here are some ways you can contribute:
10
12
11
13
-**Code Contributions:** You can contribute code examples in Rust, Python, or Solidity that demonstrate various Solana program functionalities. You can also contribute improvements to existing examples, such as bug fixes, optimizations, or additional features.
12
14
13
15
-**Bug Reports, Ideas or Feedback:** If you encounter any issues or have ideas for new examples, please submit a bug report or feature request. Your feedback is valuable and helps us improve the quality and relevance of the examples.
14
16
15
17
## Contributing code examples:
18
+
16
19
When contributing code examples, please follow these guidelines to ensure programs build and test successfully:
17
20
18
-
1. Use pnpm as the default package manager for the project. You can install pnpm by following the instructions[here](https://pnpm.io/installation). Commit pnpm-lock.yaml to the repository.
21
+
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.
19
22
20
-
2.Programs written for Solana Native should be in directory `native` and Anchor programs should be in directory `anchor`.
23
+
2.Anchor programs should be in directory `anchor`, programs written for Solana Native should be in directory `native`.
21
24
22
25
3. Tests for Solana native and Anchor programs should be written with [ts-mocha](https://github.com/piotrwitek/ts-mocha).
23
26
@@ -37,13 +40,14 @@ When contributing code examples, please follow these guidelines to ensure progra
37
40
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)
38
41
39
42
7. TypeScript, JavaScript and JSON files are formatted and linted using
40
-
[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:
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:
41
44
42
45
```bash
43
46
pnpm check:fix
44
47
```
45
48
46
49
## Code of Conduct
50
+
47
51
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:
48
52
49
53
Be respectful and inclusive in your interactions with others.
0 commit comments