Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

42 lines (30 loc) · 1.54 KB
Raw

Contributing to HTTPing

First off, thank you for considering contributing to HTTPing! It's people like you that make HTTPing such a great tool.

Here are a few ways you can help make HTTPing better:

Reporting Issues

If you find a bug or have a suggestion for a new feature, please check if it has already been reported. If not, create a new issue and provide as much detail as you can.

Submitting Pull Requests

Pull requests (PRs) are always welcome! Here's how to do it:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue the pull request!

Please note that all contributions to HTTPing must adhere to the Code of Conduct. By participating, you are expected to uphold this code.

Style Guide

Please follow these coding style guidelines:

  1. Use Go fmt for code formatting.
  2. Include comments in your code where necessary.
  3. Write tests for your new features or bug fixes.
  4. Make sure your code has proper error handling.
  5. Use descriptive variable and function names.

Running tests

Before submitting your pull request, please make sure all tests pass:

go test ./...

Commit Message guidelines

We follow the Conventional Commits specification. Please format your commit messages accordingly.

License

By contributing to HTTPing, you agree that your contributions will be licensed under the MIT License.