refactor: obtain output from TSC repo linter

Description

We need to get going with adopting the TSC repo structure recommendations where applicable and/or send PRs to the default config file (rule set parameter) where that’s more suiting.

Acceptance Criteria

1. Run the tool against the main branch of the repository
2. Post the output here, whatever it may be
3. Initiated discussion on which errors/warnings can we fix and which ones we’d like to squash by updating the repo linter rule set instead.
4. Created follow-up tasks for addressing each item as discussed during 3)

For Context the original email

Hi all,

The TSC decided to recommend that all Hyperledger projects adopt a common repository structure to provide some consistency across projects and make it easier for people to find their way around and quickly locate important information. In order to help implement it the TSC then decided to leverage the TODO group repolinter tool.

A customized configuration file has been developed for Hyperledger and I’d like to invite all the projects to try and use it.

Contrary to what was first thought, we do not want every project to copy that file into their own repos. This is bound to create a maintenance nightmare. So, instead, we’d like to try and use the same common config file.

After installing repolinter you can check your repository with the following command from the root directory of your repo:

repolinter --rulesetUrl https://github.com/hyperledger-labs/hyperledger-community-management-tools/raw/main/repo_structure/repolint.json

It is understood that the config file may not work well for all projects. We welcome contribution on how to improve it. All PRs welcome. 😃 Just keep in mind that the goal is to make the file work for everyone so don’t simply remove stuff that’s not relevant to your repo. Some errors can simply be ignored.

Finally, whether this should be integrated in your CI is up to you. As a first step it may be enough to give it a run every now and then.

Please, let us know how your experiment goes. We’re interested in both good and bad stories!

cc: @takeutak @sfuji822 @hartm @jonathan-m-hamilton @AzaharaC @jordigiam @kikoncuo @lehors

[hartm]

We should have a security reporting policy in place, and that’s what the security.md file is supposed to address. We may need to discuss how this should be handled before we add a security.md file.

[petermetz]

May I take this one?

@Leeyoungone It’s yours!