We build open-source tools and share learning resources. Contributions can be small: a reproducible bug report, a clearer explanation, a corrected example, or a focused code change.
English and Chinese are both welcome in issues and pull requests. Project-specific instructions take precedence over this guide.
Open an issue in the repository where the problem occurs. Search existing issues first, then include:
- What you expected and what happened instead.
- The smallest example or steps that reproduce the problem.
- Relevant browser, operating system, or tool versions.
- Screenshots or logs when they help. Remove private information before posting.
Describe the problem you want to solve and how the change would help someone using the project. For a substantial change, open an issue before starting implementation so we can discuss its scope.
- Fork the repository and create a branch for your change.
- Keep the change focused and follow the existing style.
- Update documentation or examples if the behavior changes.
- Run the checks documented in the project's README. For documentation-only changes, check links and the rendered Markdown preview.
- Describe the change, link any relevant issue, and explain how you checked it. For visual changes, include a screenshot when useful.
If a check cannot be run, say so in the pull request. You do not need to claim tests that you did not perform.
Triangle Light Maze Solver has a browser demo and documents its solver, smoke, and release checks in its README.