HIVE-RefData

How to contribute?

Want to help contribute to a short database of useful commands for HIVE? Check out the example.json included with this repo. This will give you the json object template that will be used for each definition. Now its time to "fill in the blanks", setup your definition using the data structure below. Then submit a PR (pull request) for review. Please remember that all submissions MUST to conform to the data structure to be accepted.

Data Structure

Alias (Optional)

Does your definition fit more than just one reference? No problem, just add any aliases here.

Title

The Title on the top of the reply box from Hive

minRank

Future

Description

This is the meat of the defintion. What is the defintion? What does it do? How does it help? Details are key. (Just remember we do have a 1950 character limit, so no 10 page essays please.)

Category

Pick a category from below or suggest a new one. We are trying to generalize everything for easy access so try to be generic. The category is also an array object, so you can use more than one!

keywords

List keywords that would help in a future search engine function.

Acceptable Categories

• infrastructure
• switching-applications
• lights
• applications
• utilities
• monitoring
• graphs
• bridge
• microcontroller
• led
• server
• general
• helpdesk
• information
• user-base
• home-assistant (More as required)

Example Object

{
  "example_command": {
    "alias": [
      "example-command",
      "Another Example"
    ],
    "title": "Title Goes Here 🔨 🥇 👍 🐿️ 🌰",
    "minRank": 0,
    "description": "This is just an example description of what this file is used for and how to set it up for collaboration.  Add your links here: \n\nhttps://github.com/Blade2021/HIVE-RefData \n[More information](https://github.com/Blade2021/HIVE/wiki) \nMore Text here if you like",
    "category": [
      "utilities"
    ],
    "keywords": [
      "sample"
    ]
  },
  "example2_blank": {
    "alias": [],
    "title": "",
    "minRank": 0,
    "description": "",
    "category": [],
    "keywords": []
  }
}

REGEX

The following will be replaced automatically:
{prefix} - Replaced with HIVE's current prefix, This keeps from having to hardcode the prefix.

Automatic Deployment

All commits to the master are validated and deployed upon successful validation. After deployment, HIVE bot may be reloaded by any member of staff to reload the reference library.