Natixar / Blockchain-frontend

Other
0 stars 0 forks source link

Some Functions Lack the Comment Block #7

Open lepeuvedic-natixar opened 2 months ago

lepeuvedic-natixar commented 2 months ago

https://github.com/Natixar/Blockchain-frontend/blob/cb0d07e4cb5f62c82b7418b30cecd8560df6a5b1/app/mine/minting/page.tsx#L7

Problem

Proper comments are required for all functions. Source code files lack copyright notice.

How to Reproduce?

Click on above link to observe the source code of the minting function.

What is Needed Instead?

Automated GitHub action that provides the equivalent of a Lint / PyLint diagnostic covering the monitoring of recommended comment and source code documentation practices. The Action should run on pull requests to main (which must be mandatory) and should block such pull requests when comments are missing or are present, but missing some information.

In addition all the source code files that are not generated automatically and used unmodified, must bear proeminent notices attributing the copyright to Natixar SAS and saying that this is proprietary code.

Sagerahl commented 2 months ago

What I've done so far: