kata-ai / development-standard Goto Github PK

Summary

Create a RFC process using the development tools we use (e.g. GitHub Issue templates). Anyone in Kata.ai team can propose changes to this development styleguide, and the Core team approves them.

Motivation

The development standard needs to be a living document, and changes made to it needs to be agreed upon by all members. Therefore, an RFC process needs to be created to introduce a process to make changes to this styleguide.

Exceptions

N/A

Drawbacks

N/A

Additional Context

The PR description here outlines the rough template that we can use for the RFC. We can change this throughout the lifetime of this PR when necessary.

We can implement this using GitHub's Issue templates (.github/ISSUE_TEMPLATE/rfc.md). I don't know if Gitlab has a similar system.

Summary

We need to ensure our development tooling keeps in track with the current practices. TSLint is already deprecated. Therefore, we will need to port the configs for our development standard to its ESLint counterpart.

Moreover, to prevent the headache of formatting code, we should standardise using Prettier, which is supported on many editors, and is runnable during commit time with tools like lint-staged.

Motivation

This RFC serves as a baseline for proper linting + formatting within all JavaScript/TypeScript codebase within Kata.ai, to ensure all JavaScript/TypeScript codes align to the Development Standard.

In future RFCs, we may also tinker around with tools like lint-staged for automatically running Prettier on commit time.

Exceptions

For projects within Kata.ai that are about to be sunset, this change need not applied.

Drawbacks

We need to factor in maintenance costs in applying the new ESLint config. In many cases, most of the code formatting issues can be solved by Prettier implementation. In addition, since the ESLint config as it stands is an extension of Airbnb config, any linting rules that didn't align to our Standard shall be fixed and published to npm.

Additional context

The new ESLint config has already been developed alongside Aksara UI, and we use that project, as well as other frontend projects within Kata.ai, to dogfood the ESLint config's implementation.

The ESLint config will live in https://github.com/kata-ai/eslint-config-kata. Further changes to the ESLint config shall go through another RFC process in the Development Standard.