development_rules_and_guidelines.adoc

Development rules and guidelines

Table of Contents

• Introduction
• General user experience
• Prompts
• Variables
• Templates

Introduction

These rules and guidelines will help and guide you when implementing features and working on ProjectInit.sh development.

The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

General user experience

1. All questions a user should answer when running ProjectInit MUST be asked before any changes to the filesystem are made.

Prompts

1. All "yes/no" prompts MUST implement the following acceptable input:

   • for "yes": "y"|"yes"|"yup"|"yeah"|"1"

   • for "no": "n"|"no"|"nope"|"2"

Variables

1. All global variable names MUST start with projectinit_.

2. All global variable names MUST use snake_case and be lowercase. When a variable is in uppercase, it SHOULD mean that it’s holding an environment variable.

3. All global variables MUST be documented in Global variables documentation.

4. You SHOULD reuse existing global variables whenever possible. When you are developing a new feature, take a look at Global variables documentation first and see if any of the already existing global variables can be used.

Templates

1. All placeholders inside templates MUST be placed between a pair of 3 tilde characters. Example: ~~~your template placeholder~~~