πŸ““
Dev Guidelines
logo
​

Table of Contents

  1. 1.
    Abstract
  2. 2.
    TIOF general Dev Guidelines
  3. 3.
    Project Lockdown specific Dev Guidelines
  4. 4.
    Additional information

Project Organization

General considerations

Milestones

Projects in TIOF use Milestones to establish relevant deadlines in order to structure their implementation.
Milestones are created and maintained by:
  • TIOF Management
  • Project Managers
Milestones are organized in 2 levels:
  • Organization-wide These Milestones apply across all the organization and are to be observed mainly by TIOF's organization core as well as Project Managers.
  • Project-wide These Milestones apply specifically to a given TIOF Project and are to be observed by all Project's Teams.

GitHub Issues

  • Templates
  • Labels
  • Pinned Issues
When creating a new Feature
  • Create a Root Issue
  • List all subtasks as Tasks Markdown)
  • Create the necessary Issues for each task and populate them with the necessary information as per template.
  • Add the Issue # to the Root Issue (@@@ Look into automating this. Should be doable.)
Issues: For each Task, indicate the # corresponding to the Issue that will implement it
Automation need:
  • To create Issues based on Task Lists
  • To add (#TBC) when a Task item doesn't have and Issue associated
Pull Requests
  • Templates
​

Abstract

Back to top

TIOF general Dev Guidelines

@@@ Link to TIOF' Repo
@@@Add
  • Package.json
Comment using "scriptsComments": { "FIELD": "COMMENT" },
{ "name": "package name", "version": "1.0", "description": "package description", "scripts": { "start": "npm install && node server.js" }, "scriptsComments": { "start": "Runs development build on a local server configured by server.js" }, "dependencies": { "ajv": "^5.2.2" }, "dependenciesComments": { "ajv": "JSON-Schema Validator for validation of API data" } }
Source: https://stackoverflow.com/questions/14221579/how-do-i-add-comments-to-package-json-for-npm-install
  • TIOF Labels
Back to top

Project Lockdown specific Dev Guidelines

Issues:
  • PLD Labels
Code:
  • ​DRY (Don't repeat yourself)
  • ​KISS (Keep it simple, stupid)
  • Scout rule. Leave the campground cleaner than you found it.
  • Always fix the root cause of the problem instead of symptoms treatment.
  • Be consistent. If you do something a certain way, do all similar things in the same way.
  • Use explanatory, unambigous names
  • Replace magic numbers with named constants.
  • Make functions small, do one thing
  • Use components' composition to make components smaller react example​
Most of the rules where taken from this summary of "Clean Code" - the book: https://gist.github.com/wojteklu/73c6914cc446146b8b533c0988cf8d29
Back to top

Additional information

Back to top