NDI Tech's GitHub Guidelines

Policies - Documentation - Style - Readme - Sample(s)

This repository is used for NDI Tech Team's standardized readme files, documentation, style guide and GitHub policies.

GitHub Policies

• Follow Collaborator Access Guide before giving NDI Tech GitHub access to vendors, consultants, freelancers and contributors.
• Please follow File and Folder Guide before creating GitHub repository and Google Drive folder.

Documentation

• "Write the documentation so that the 2nd developer can explain the repository to the 3rd one."

Style Guide

• When commit code, follow Code Commit Guide.
• When working with Javascript and or React project, follow Google's Javascript Style Guide and Airbnb's React Style Guide.
• Some old projects did not follow this standard but this applies to new ones (from September 2018).
• Keys:
  • Use all-lower-case-file-name.js except in React folders, ReactComponent (PascalCase) and reactProjectFile.js (camelCase).
  • Use semicolon to close statements, except function and class declarations.

Readme Format

• NDI logo (looks nice)
• Name of the Repo/Script/App
• List of important stuff: license... (currently not using distributed continuous integration services like Travis or circleci)
• List of Headings: makes it easier to navigate in long file.
• Documentation: guide to use and to troubleshoot.
• Testing: guide to do tests.
• Installation: guide so users can run the app.
• Contributing: guide for other developers in the future.
• License: best practice to include license, however this can be omitted. Recommended license for public repositories: GNU General Public License v3.0 (gpl-3.0), for private repositories: Apache license 2.0 (apache-2.0).
• Author(s)

Readme Samples

• Private Repository Readme File
• Public Repository Readme File