Guidelines for developers and licenses - noi-techpark/odh-docs GitHub Wiki

Guidelines and Policies for the team to follow

Guidelines for contributors and new developers

Guidelines for the core team

Guidelines for Web Components

Naming of Web Components

  1. All web components html tag names have to (mandatory) start with "odh-". (policy created on April 2nd, 2021)
  2. All web components html tag names have NOT to (mandatory) include "webcomp", "widget" or any generic abbreviation. Use the git repo name, which is "webcomp-", replacing "webcomp-" through "odh-". (policy created on April 2nd, 2021)
  3. All web components titles have NOT to (mandatory) include "Web Component" now "Widget". (policy created on April 2nd, 2021)

Software Licenses

  1. All repositories have to (mandatory) include a license under which the source code is released. By default we release source code in our repositories under the AGPL-3.0-or-later.

Content Licenses

  1. All repositories should (optional) include licenses for content (like pictures, icons, text other media) under which we or the authors release them. By default we release content in our repositories under the CC0-1.0.

REUSE

  1. All repositories should be REUSE compliant, find our REUSE guidlines here.

Trademark Policy

  1. All repositories should (optional) contain a trademark.md file, to explain how third parties have to handle contained trademarks.

Analytics of web apps

  1. All web apps have to (mandatory) include analytics to be able to analyze the use of the tool and plan future investments. (policy created on April 2nd, 2021)