Make an issue clear
Include the version, input, command and result. A small independent reproduction often says more than a long description.
Open source · Contribution guide
Build together.
Start with a
specific improvement.
Find your contribution+
One clear issue.
One reproducible example.
One lesson worth sharing.
Every kind of expertise
can leave a contribution.
Beyond code, clear documentation, reproducible issues and real engineering constraints make a project better.
Make an implementation more dependable
Cover boundaries, failure paths and tests. Demonstrate the need, then make the change verifiable.
Make the method easier to understand
Improve setup instructions, examples and bilingual explanations. Understanding comes before reuse.
From local evidence,
to a reviewable change.
Start with an independently reproducible workspace using a downloaded reference kit. Then discuss the improvement.
- 01
Choose an exact version
Record the version and checksum, then read the README and LICENSE.
- 02
Reproduce the current behaviour
For code kits, run the example and tests. For templates, check fields and instructions. Reproduce issues with synthetic data.
- 03
Keep the change focused
Solve one issue at a time and include relevant tests and documentation.
- 04
Prepare material for review
Prepare the reason, diff, reproduction and impact, then use the project’s confirmed collaboration channel.
Make the issue
something others can reproduce.
Provide two key details to create a local Markdown issue file. Bring it to the discussion with the code and test results.
Generated locally; nothing is uploaded or sent. Use synthetic data and remove credentials and customer information.
Download a blank templateA clear basis for collaboration.
License & attribution
The reference kits use the MIT license. Retain the included notices when using or redistributing them, and contribute material you have the right to share.
Read the reference licenseVerification & reproducibility
Include version, environment, minimal input and expected output. Passing tests do not establish suitability for every business; document limits and changes.
Clear scopeTest evidenceNo sensitive data
The next improvement
could start with you.
Reference packages are currently available here. Repository and contribution channels are announced with each project; generating an issue file does not create an online issue.