Netsells Code Standards

Netsells aims to keep up to date with emerging technologies and ensure that code is structured in a consistent, readable and maintainable way. On top of this, we aim to build highly performant products, utilising the best methods of tackling complex problems.

The set of standards provided herein exist to onboard new developers within the Netsells organisation, and assist in working with external companies on collaborative codebases.

Monorepo

As well as being a place to house documentation, this repository also serves as a monorepo for various packages that provide tools for enforcing code standards.

• Eslint Config
• Stylelint Config

Contributing

If this document is inaccurate, or you spot mistakes, please submit an issue or pull request on the GitHub repository.

Development

This site is built using Vuepress, to learn more check out the Official Documentation.

git clone git@github.com:netsells/code-standards.git
npm run dev

Building

You can build the docs locally using the following command:

npm run build

Deploying

This project automatically builds and deploys to Github Pages using a Github Action. You don't need to commit any compiled Vuepress files.