Skip to content

Latest commit

 

History

History
49 lines (36 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

49 lines (36 loc) · 2.79 KB

snap collector plugin - ethtool

  1. Contributing Code
  2. Contributing Examples
  3. Contribute Elsewhere
  4. Thank You

This repository is primarily community supported. We both appreciate and need your contribution to keep it stable. Thank you for being part of the community! We love you for it.

Contributing Code

IMPORTANT: We encourage contributions to the project from the community. We ask that you keep the following guidelines in mind when planning your contribution.

  • Whether your contribution is for a bug fix or a feature request, create an Issue and let us know what you are thinking
  • For bugs, if you have already found a fix, feel free to submit a Pull Request referencing the Issue you created
  • For feature requests, we want to improve upon the library incrementally which means small changes at a time. In order ensure your PR can be reviewed in a timely manner, please keep PRs small, e.g. <10 files and <500 lines changed. If you think this is unrealistic, then mention that within the issue and we can discuss it

Once you're ready to contribute code back to this repo, start with these steps:

  • Fork the appropriate sub-projects that are affected by your change
  • Clone the fork to $GOPATH/src/github.com/intelsdi-x/ 
     $ git clone https://github.com/<yourGithubID>/<project>.git
  • Create a topic branch for your change and checkout that branch 
    $ git checkout -b some-topic-branch
  • Make your changes and run the test suite if one is provided (please write some 😄)
  • Commit your changes and push them to your fork
  • Open a pull request for the appropriate project
  • Contributors will review your pull request, suggest changes, and merge it when it’s ready and/or offer feedback
  • Again - to report a bug or issue, please open a new issue against this repository

If you have questions feel free to contact the maintainers by tagging them: @intelsdi-x/plugin-maintainers.

Contributing Examples

The most immediately helpful way you can benefit this project is by cloning the repository, adding some further examples and submitting a pull request. A few topics we always want more examples of:

  • Reading metrics from NIC's registry dump
  • Unification of metrics' names if discrepancies between vendors exist

Have you written a blog post about how you use Snap? Send it to us on Gitter!

Contribute Elsewhere

This repository is one of many plugins in snap, a powerful telemetry framework. See the full project at http://github.com/intelsdi-x/snap

Thank You

And thank you! Your contribution, through code and participation, is incredibly important to us.