Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (39 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

46 lines (39 loc) · 1.79 KB

Contributing to ipmi_exporter

In the spirit of free software, everyone is encouraged to help improve this project. Here are some ways that you can contribute:

  • Use alpha, beta, and pre-released software versions.
  • Report bugs.
  • Suggest new features.
  • Write or edit documentation.
  • Write specifications.
  • Write code; no patch is too small: fix typos, add comments, add tests, clean up inconsistent whitespace.
  • Refactor code.
  • Fix issues.
  • Review patches.

Submitting an issue

We use the GitHub issue tracker to track bugs and features. Before you submit a bug report or feature request, check to make sure that it has not already been submitted. When you submit a bug report, include a Gist that includes a stack trace and any details that might be necessary to reproduce the bug.

Submitting a pull request

  1. Fork the repository.
  2. Create a topic branch.
  3. Implement your feature or bug fix.
  4. When making code changes, ideally add tests and ensure that they completely cover your changes and potential edge cases.
  5. If there are pre-existing tests, run go test. If tests fail, revise your code and tests, and repeat go test until they pass.
  6. Add documentation for your feature or bug fix in the code, documentation, or PR/commit message.
  7. Commit and push your changes.
  8. Submit a pull request that includes a link to the issues for which you are submitting a bug fix (if applicable).