Open lepeuvedic-natixar opened 2 months ago
What I've done so far:
Updated Comments and Documentation: I’ve updated the code comments to improve the documentation, including the MintingForm function.
License and Copyright Notice: I’ve also added a LICENSE file to the repository, which includes attribution to Natixar SAS and states that this is proprietary code. I’d be happy to replace the current LICENSE file with one that adheres more closely to the company's legal requirements.
GitHub Action for Linting: To ensure that all future pull requests are compliant with linting standards, I’ve created an automated GitHub Action. This action automatically runs npm run lint on all pull requests, regardless of the branch, to enforce proper documentation and coding standards. How it works:
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.