Skip to content

Commit 3a55701

Browse files
authored
Merge pull request #927 from cnlohr/how_to_commit
Add Contributing section to README.md
2 parents 175481f + bc6405d commit 3a55701

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,17 @@ Other third party tools are adding lots of examples, etc. See the following rep
117117

118118
You can open a github ticket or join my Discord in the #ch32fun channel. Right now invites are private, so just ping me @cnlohr for an invite link. My PMs are open.
119119

120+
## Contributing to ch32fun
121+
* The ch32fun project has an existing style of coding both in formatting and in overall design philosophy. Please ensure your code meets these standards. Continuing development of this aesthetic takes place primarily on our Discord community which contributors are encouraged to join. Please reach out to @cnlohr on Discord.
122+
123+
* Contributors who propose significant contributions to ch32fun are encouraged to join our Discord to discuss your plans at the early stages of your design. The community can provide guidance and other assistance to facilitate your work with both technical and stylistic guidance. Specifically, contributions from outside of our community will receive greater scrutiny.
124+
125+
* While English is the primary language of this project, contributions are best made in the native language of the contributor unless they feel comfortable with doing so in English. Our project has members from all over the world, please don’t let your comfort with English stop you from contributing.
126+
127+
* Contributions must be the work of the submitter. If other resources are used in the development of the work, they must be primarily the work of the submitter. Tool generated code from documents will not be accepted. To this end, contributors must be able to discuss in detail the technical aspects of their work as well as the motivations for creating it.
128+
129+
* Once a contribution is accepted, its submitter is expected to provide basic support for their code. If you are tagged in an issue, please accept ownership of the issue and work to resolve it.
130+
120131
### Footnotes/links
121132

122133
* https://raw.githubusercontent.com/openwch/ch32v003/main/RISC-V%20QingKeV2%20Microprocessor%20Debug%20Manual.pdf Debugging Manual

0 commit comments

Comments
 (0)