Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

61 lines (42 loc) · 3.51 KB
Raw

Contributing to Machine Data Hub

Welcome!

Thank you for considering contributing to Machine Data Hub. It's people like you that make Machine Data Hub such a great tool.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assess changes, and helping you finalize your pull requests.

Possibilities

Machine Data Hub is an open source project, and we love to receive contributions from our community! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, or writing code which to be incorprated into Machine Data Hub.

Known Issues

Please do not use the issue tracker for [support questions].

Ground Rules

Expectations

Responsibilities

  • Ensure cross-platform compatibility for every change that's accepted. Windows, Mac, Debian & Ubuntu Linux.
  • Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
  • Don't add any classes to the codebase unless absolutely needed. Err on the side of using functions.
  • Keep feature versions as small as possible, preferably one new feature per version.
  • Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See our Code of Conduct.

Your First Contribution

Unsure where to beging contributing to Machine Data Hub? You can start by looking through the known issues.

Bonus points: Add a link to a resource for people who have never contributed to open source before.

Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.

Getting started

Code Changes

For something that is bigger than a one or two line fix:

  1. Create your own fork of the code
  2. Do the changes in your fork
  3. If you like the change and think the project could use it:
    • Be sure you have followed the code style for the project.

Smaller Changes

Small contributions such as fixing spelling errors, where the content is small enough to not be considered intellectual property, can be submitted on the Small Patches Issue. Examples of these are:

  • Spelling / grammar fixes
  • Typo correction, white space and formatting changes
  • Comment clean up
  • Bug fixes that change default return values or error codes stored in constants
  • Adding logging messages or debugging output
  • Changes to ‘metadata’ files like Gemfile, .gitignore, build scripts, etc.

How to report a bug

Bugs should be posted in Issues with the 'bug' label.

Any security issues should be submitted directly to conduct@machinedatahub.ai. In order to determine whether you are dealing with a security issue, ask yourself these two questions:

  • Can I access something that's not mine, or something I shouldn't have access to?
  • Can I disable something for other people?

If the answer to either of those two questions are "yes", then you're probably dealing with a security issue. Note that even if you answer "no" to both questions, you may still be dealing with a security issue, so if you're unsure, just email us at conduct@machinedatahub.ai.