Linx Sample conventions - linx-software/samples GitHub Wiki

General principles

  1. Keep it simple. If you don't need it now...lose it.
  2. Don't repeat yourself.
  3. Follow the conventions, but not at the expense of 1 and 2.
  4. Treat these principles as rules. You may intentionally break them for a good reason.

Linx

  • Names should be meaningful and descriptive.
  • Names should be in PascalCase e.g. FirstName.
  • Avoid abbreviations except for the ultra common ones e.g. XML is ok, NFT is not.

Database

Naming

Type Rule Example
Column names Singular and PascalCase FirstName
Table names Plural and PascalCase Customers
Primary keys Singular and PascalCase Id
Foreign keys [Singular of Table]Id CustomerId

Scripts

Put database scripts under a database folder at the root of the repo.

[database]
    └── setup-script.sql

Repository

The repo must include a readme.

The repo structure must be clear and descriptive e.g.

root
├── README.md
├── Solution.lsoz
├──[database]
|   ├─ setup-script.sql
|   └─ ...
├──[img]
|   ├─ screenshot.jpg
|   └─ ...
|──[ui]
|   ├─ js
|   ├─ html
|   └─ ...
└──[test]
    ├─ customers-source.csv
    |─ customers-target.csv
    └─ ...

Readme

The readme should generally follow the format below.

  • Project name
  • Description. A short and clear description of why the project exists and what it does.
  • Installation
  • Usage
  • Contributing. Explain how people can contribute to the project.
  • License

Do not include a Table of Contents as Github automatically generates it.

See the readme template for a good starting point.