Skip to content

Latest commit

 

History

History
79 lines (57 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

79 lines (57 loc) · 3.24 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/esnet/gdg/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Code Submissions

Any code submitted to enhance this project is great appreciated, but here's a check list to look at which will help ensure a successful code review.

  1. Make sure the code works, compiles and so on.
  2. We have a docker-compose file that will bring up an instance of grafana. A variety of integration tests exists under the integration_tests folder. Ideally each new entity we introduce should have tests that go with it. Please make sure you have a test for you code submission.
  3. Configuration Changes: Please update the conf/importer-example.yml if you are introducing any new configs
  4. Document the code, not every line needs docs, but explaining what the function does is helpful for those that follow.
  5. The generated docs live under documentation/content/en/docs/ Please update the md files to reflect your changes to let others know how to use the tool. usage_guide.md is likely the only file you'll need to update.
    • documentation/content/en/docs/releases contains a list of changes, if you are adding a new feature, please add a short description of the upcoming new feature.
    • documentation/content/en/docs/usage_guide.md provides simple examples. If you're adding a new entity please document its behavior.
  6. If you've introduced a major change that affects the configuration, please take the time to update the context new wizard to ensure it's captured.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/esnet/gdg/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here's how to set up gdg for local development.

  1. Fork the gdg repo on GitHub.
  2. Clone your fork locally::
    $ git clone [email protected]:your_name_here/gdg.git
  1. Create a branch for local development::
    $ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

  1. When you're done making changes, check that your changes pass the tests::
    $ make test
  1. Commit your changes and push your branch to GitHub::
    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature
  1. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.