Skip to content

Latest commit

 

History

History
74 lines (44 loc) · 3.9 KB

CONTRIBUTING.md

File metadata and controls

74 lines (44 loc) · 3.9 KB

Contributing to Sisense Embed SDK Demo

First off, thanks for taking the time to contribute! 👍

The following is a set of guidelines for contributing to this project on GitHub. Use your best judgment, and feel free to propose changes to this document in a pull request.

Further Questions

For questions that aren't covered by this document as well as the project's README.md file and Embed SDK's online documentation, please contact [email protected]

Table Of Contents

What should I know before I get started?

How Can I Contribute?

What should I know before I get started?

Project Purpose

The purpose of this project is to demonstrate the correct use of the Sisense Embed SDK to embed Sisense dashboards in other web applications, so that said application's developers can learn the SDK's syntax and capabilities in a hands-on fashion.

The project is not intended to demonstrate how to build or design said web application, neither is it intended to meet specific business requirements or be used as a plug-and-play solution for a production project.

Project Requirements

This demo was designed to meet the following requirements. Any contributions should strive to meet the same requirements, although exceptions may be considered.

1. The demo should be as easy as possible to deploy

As such, it should only require a minimal set of assets needed to demonstrate the SDK's capabilities. For example: dashboards that are built to work with the demo's UI are reasonable, but Sisense plugins are not.

These assets should be included in the repository.

In addition, as few tools and setup steps as possible should be required to complete setup of this demo.

2. The demo should cover as much of the SDK functionality as possible

In order to provide an opportunity for learning the various capabilities of the SDK, while maintaining a reasonable business/user story behind the application.

3. The demo should run on any environment in which Sisense may be run

To ensure all Sisense users can enjoy using this demo, it should be possible to run in any environment supported by Sisense.

As such, the web application's code should be valid and executable in any modern browser as well as Internet Explorer 11 and PhantomJS headless browser. To do so, ES2015/JS6 syntax should be avoided or compiled to the older standard using a tool such as BabelJS, and polyfills should be included as needed.

In addition, use and customization of the demo should not require a specific OS or IDE.

How Can I Contribute?

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Keep it short and descriptive

Pull Requests

Please follow these steps to have your contribution considered by the maintainers:

  1. Read this document, as well as the project's README.md and all inline code comments thoroughly
  2. Keep the requirements listed above in mind
  3. Do not introduce new dependencies to the project (exceptions may be considered - please elaborate in pull request description)
  4. Ensure your code uses a similar design and layout to existing project code
  5. Document your code with valid HTML or JSDoc format comments, as well as changes to the README when applicable
  6. Code and comments should be in clear English and must be written in a civil, respectful language
  7. Submit a pull request with a detailed description of changes and their purpose

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.