Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

50 lines (31 loc) · 2.14 KB
Raw

Contributing Guidelines

👍🎉 First off, we appreciate you taking the time to contribute! THANK YOU! 🎉👍

We put together the handy guide below to help you get support for your work. Read on!

I Just Want to Ask the Maintainers a Question

The Linode Community is a great place to get additional support.

How Do I Submit A (Good) Bug Report or Feature Request

Please open a GitHub issue to report bugs or suggest features.

Please accurately fill out the appropriate GitHub issue form.

When filing an issue or feature request, help us avoid duplication and redundant effort -- check existing open or recently closed issues first.

Detailed bug reports and requests are easier for us to work with. Please include the following in your issue:

  • A reproducible test case or series of steps
  • The version of our code being used
  • Any modifications you've made, relevant to the bug
  • Anything unusual about your environment or deployment
  • Screenshots and code samples where illustrative and helpful

How to Open a Pull Request

We follow the fork and pull model for open source contributions.

Tips for a faster merge:

  • address one feature or bug per pull request.
  • large formatting changes make it hard for us to focus on your work.
  • follow language coding conventions.
  • make sure that tests pass.
  • make sure your commits are atomic, addressing one change per commit.
  • add tests!
  • make sure your commits are signed.

Code of Conduct

This project follows the Linode Community Code of Conduct.

Vulnerability Reporting

If you discover a potential security issue in this project we ask that you notify Linode Security via our vulnerability reporting process. Please do not create a public github issue.

Licensing

See the LICENSE file for our project's licensing.