satd-patterns

Collection of patterns to identify technical debt in code comments

Usage no npm install needed!

<script type="module">
  import satdPatterns from 'https://cdn.skypack.dev/satd-patterns';
</script>

README

xsultan/satd-patterns Build Status

A list of patterns used to identify technical debt through source code comments.

Technical debt refers to incomplete or temporary workarounds that allow us to speed software development in the short term at the cost of paying a higher price later on. Recently, studies have shown that technical debt can be detected from source code comments, referred to as self-admitted technical debt.

A list of patterns to detect technical debt from source code comments, it is just a JSON file so it is convenient to be used.

Install

$ npm install --save satd-patterns

const satd-patterns = require('satd-patterns');

console.log(satd-patterns);
//=> ['hack', 'workaround', 'fixme', ...]

Related Publication

License

MIT © Sultan Wehaibi