Contributing to Ply

Contributions are welcome, whether you are fixing a typo, improving the documentation, reporting a bug, or adding a feature.

Ways to contribute

• Bug reports. Open an issue with a minimal reproduction and the expected behavior.
• Documentation. Open a pull request for unclear or missing explanations.
• Feature proposals. Start a thread in GitHub Discussions before opening a large pull request.
• Code. Pick an open issue, keep the change focused, and include tests where behavior changes.

Working on a change

1. Fork the repository and create a branch from main.
2. Make the change and run go build ./..., go vet ./... and go test -race ./....
3. For documentation changes, run the docs build from docs/.
4. Open a pull request describing the problem and the approach.

If you are unsure where to start, open a discussion or ask on an issue. Maintainers will point you to a suitable task.

Review

Pull requests are reviewed for correctness, API stability and consistency with the existing code. Small, focused changes are easier to review and merge. By participating, you agree to follow the Code of Conduct.