Skip to content

Latest commit

 

History

History
53 lines (29 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

53 lines (29 loc) · 2.86 KB

Contributing

Contributions are welcome and encouraged!

Whether you’re fixing a bug, adding a new feature, improving documentation, or proposing changes to these guidelines, your efforts help improve the project for everyone. Please review the following guidelines before contributing. If you have suggestions to improve these guidelines, feel free to update this file and submit a pull request.

Have a Question?

If you have any questions about how to use hq-go-http, please use other communication channels (such as discussion forums or community chats) instead of opening a GitHub issue.

Caution

Our issue tracker is reserved for bug reports and feature requests. Questions that are not directly related to a bug or feature request may be closed to keep the issue tracker focused.

Found a Bug?

If you've identified a bug in hq-go-http, please create an issue. If you are able to fix the bug, feel free to submit a pull request with your solution. Reference the bug issue in your PR description so that it can be linked automatically.

Have a Feature Request?

If you have an idea for a new feature or an enhancement:

  • Document Your Request:

Start by submitting an issue that outlines your proposed feature.

  • Discuss and Refine:

Engage in the discussion within the issue. This helps clarify the scope and requirements of the feature.

  • Contribute Code:

If you decide to implement the feature, submit a pull request that references the issue (for example, using fixes #<issue-number>) so that the issue is automatically closed once your PR is merged.

Ready to Contribute

Create an issue

  • Search Existing Issues:

Before submitting an issue, search our issue tracker to see if the issue has already been submitted.

  • Submit an Issue:

Assuming no existing issues exist, please open a new issue, ensure you include required information when submitting the issue to ensure we can quickly reproduce your issue. We may have additional questions and will communicate through the GitHub issue, so please respond back to our questions to help reproduce and resolve the issue as quickly as possible.

Create a Pull Requests

Pull requests should target the dev branch. Please also reference the issue from the description of the pull request using special keyword syntax to auto close the issue when the PR is merged. For example, include the phrase fixes #14 in the PR description to have issue #14 auto close.