Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 3.03 KB
Raw

Contributing to SquaredUp Samples

SquaredUp actively encourages external contributions so that the project can develop in such a way that benefits the wider SquaredUp community.

As a contributor, here are the guidelines we would like you to follow:

Code of Conduct

Help us keep SquaredUp Samples open and inclusive. Please read and follow our Code of Conduct.

Got a Question?

Please do not open issues for general support questions as we want to keep GitHub issues for bug reports and requests.

Please use SquaredUp Community Answers to ask questions. The forums provide

  • direct access to many people with extensive experiance with SquaredUp
  • public viewing so your question and its answer can help someone else
  • central location where you and others can search for previously asked questions and answers

Found a problem?

If you find a bug or a problem, you can help us by:

Got something to share?

If you would like to share a new dashboard, or a useful script you've created, please submit a Pull Request with your work.

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

  1. Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort.
  2. Include supporting information (readme.md & screenshots).
  3. Commit your changes using a descriptive commit message.

Creating a pull request for a Dashboard

  1. Create a sub-folder in dashboards following the naming convention of product-type-title.
  2. Add a dashboard.json file with the JSON from your SquaredUp dashboard.
  3. Include a README.md file which includes a brief description and everything that another user needs to know in order to implement your dashboard.
  4. Create an images sub-folder for your supporting screenshots.

Creating a pull request for code snippets & scripts

  1. Add an .md file into the relevant folder.
  2. Make sure the .md filename accurately describes the sample.
  3. Provide instructions on how and where to use the sample.
  4. Format the code sample using code blocks.
  5. Optionally, include a screenshot in the .md.

Don't have a GitHub account?

If you are unable to contribute directly into GitHub, feel free to contact support@squaredup.com for assistance.

That's it, thank you for your contribution!