blackteay/gin
3
0
Fork 0
mirror of https://github.com/gin-gonic/gin.git synced 2025-10-12 02:58:08 +08:00
Code Issues Projects Releases Wiki Activity
gin/CONTRIBUTING.md
Bo-Yi Wu 6a1d1218c3
docs: revamp contributing guidelines with comprehensive instructions (#4365) 
- Rewrite and expand the contributing guidelines for clarity and thoroughness
- Add distinct sections for Issues and Pull Requests with step-by-step instructions
- Include links to documentation, user guides, and the discussions forum
- Provide advice for reporting bugs and making feature requests
- Specify requirements for pull requests, including branch, commit count, and test coverage
- Clarify documentation expectations for new features and reference the pull request checklist
- Add guidance for security-related bug reports and communication language

Signed-off-by: appleboy <appleboy.tw@gmail.com>
2025-09-21 17:39:33 +08:00

2.1 KiB
Raw Blame History

Contributing

We welcome both issue reports and pull requests! Please follow these guidelines to help maintainers respond effectively.

Issues

  • Before opening a new issue:

    • Use the search tool to check for existing issues or feature requests.
    • Review existing issues and provide feedback or react to them.
    • Use English for all communications — it is the language all maintainers read and write.
    • For questions, configuration or deployment problems, please use the Discussions Forum.
    • For bug reports involving sensitive security issues, email appleboy.tw@gmail.com instead of posting publicly.

  • Reporting a bug:

    • Please provide a clear description of your issue, and a minimal reproducible code example if possible.
    • Include the Gin version (or commit reference), Go version, and operating system.
    • Indicate whether you can reproduce the bug and describe steps to do so.
    • Attach relevant logs per Logging Documentation.

  • Feature requests:

    • Before opening a request, check that a similar idea hasn’t already been suggested.
    • Clearly describe your proposed feature and its benefits.

For API Documentation, User Guides, and more, see:

Pull Requests

Please ensure your pull request meets the following requirements:

  • Open your pull request against the master branch.
  • Your pull request should have no more than two commits — squash them if necessary.
  • All tests pass in available continuous integration systems (e.g., GitHub Actions).
  • Add or modify tests to cover your code changes.
  • If your pull request introduces a new feature, document it in docs/doc.md, not in the README.
  • Follow the checklist in the Pull Request Template.

Thank you for contributing!