◈ ArtifactScan
← Projects
/
compendium-v2 · 2026-04-21
compendium-v2 · 2026-04-21
https://gitlab.software.geant.org/geant-swd/compendium-v2/ ↗
34
%
✓
18
/53
Passed
⚠
28
/53
Warnings
✕
6
/53
Failures
—
0
/53
Skipped
ℹ
1
/53
Info
📁
ARTEFACTS
3/7
📖
README
8/29
⚖
LICENSE
3/4
👥
AUTHORS
0/1
📝
CHANGELOG
2/9
🤝
CONTRIBUTING
0/1
💾
FILES
2/2
3/7
passed
4 warnings
README file found: README.md
LICENSE file found: LICENSE.txt
NOTICE file not found
💡 How to fix
Suggested fix
Create a NOTICE file if your licence requires it (e.g. Apache-2.0). List third-party components, their licences, and required attribution notices.
COPYRIGHT file not found
💡 How to fix
Suggested fix
Create a COPYRIGHT file listing copyright holders, years, and organisation (e.g. "Copyright © 2024 GÉANT Association").
AUTHORS file not found
💡 How to fix
Suggested fix
Create an AUTHORS file listing the main developers and contributors, their roles, affiliations and optionally contact details.
CHANGELOG file found: CHANGELOG.md
CONTRIBUTING file not found
💡 How to fix
Suggested fix
Create a CONTRIBUTING.md explaining how to report bugs, suggest features, and submit pull requests.
8/29
passed
4 failed
16 warnings
1 info
Project name detected in README
No clear copyright one-liner detected in README
💡 How to fix
📄 README
Suggested fix
Add a short copyright line near the top of README.md, e.g. "Copyright © 2024 GÉANT Association. Licensed under MIT."
No explicit lifecycle/status detected in README
💡 How to fix
📄 README
Suggested fix
Add a project status badge or line indicating the lifecycle stage, e.g. "Status: Stable", "Status: Beta".
No tags/keywords detected in README
💡 How to fix
📄 README
Suggested fix
Add a "Tags:" or "Keywords:" line in README.md to help discoverability.
No clear version indication in README
💡 How to fix
📄 README
Suggested fix
Add the current stable version near the top of README.md, e.g. "Version: 2.1.0" or a shields.io release badge.
Licence one-liner/link not detected in README
💡 How to fix
📄 README
Suggested fix
Add a one-line licence statement with a link, e.g. "Licensed under the [MIT Licence](LICENSE)."
Description/overview detected
No features section in README
💡 How to fix
📄 README
Suggested fix
Add a "Features" section listing the key functionalities as a bullet list.
No clear scope section in README
💡 How to fix
📄 README
Suggested fix
Add a "Scope" or "Use Cases" section describing when and how the software should (and should not) be used.
No compatibility section in README
💡 How to fix
📄 README
Suggested fix
Add a "Compatibility" section listing supported OS, browsers, versions, or integration targets.
No structure section in README
💡 How to fix
📄 README
Suggested fix
Add an "Architecture" or "Project Structure" section explaining the directory layout and main components.
Requirements detected
Installation signals detected
Usage + code blocks detected
No documentation location in README
💡 How to fix
📄 README
Suggested fix
Add a "Documentation" section linking to your docs site, wiki, or docs/ folder.
Branch/tag wording detected
No troubleshooting/FAQ in README
💡 How to fix
📄 README
Suggested fix
Add a "Troubleshooting" or "FAQ" section addressing common issues.
Support/contact wording detected
No privacy policy in README
💡 How to fix
📄 README
Suggested fix
If the software processes personal data, add a "Privacy" section or link to a privacy policy.
No roadmap in README
💡 How to fix
📄 README
Suggested fix
Add a "Roadmap" section or link to a public issue tracker milestone.
No authors mention in README
💡 How to fix
📄 README
Suggested fix
Add an "Authors" section or link to the AUTHORS file.
No contributing guidance in README
💡 How to fix
📄 README
Suggested fix
Add a "Contributing" section or link to CONTRIBUTING.md.
No funding info in README
💡 How to fix
📄 README
Suggested fix
Add a "Funding" section mentioning the funding source, grant agreement number, and programme.
No acknowledgements in README
💡 How to fix
📄 README
Suggested fix
Add an "Acknowledgements" section thanking third-party projects, partners, or contributors.
DependencyParser found no dependencies in README/NOTICE sections
No tools indicators in README
📄 README
No licence summary in README
💡 How to fix
📄 README
Suggested fix
Add a "Licence" section near the bottom of README.md with a short summary and link to the full LICENSE file.
No COPYRIGHT reference in README
💡 How to fix
📄 README
Suggested fix
Add a "Copyright" line referencing the COPYRIGHT file and listing copyright years and holders.
All README local links are valid
3/4
passed
1 warnings
LICENSE file has adequate length (1094 characters)
ScanCode detected licenses: APACHE-2.0, BSD-3-CLAUSE, ISC, MIT, UNKNOWN-LICENSE-REFERENCE
LICENSE file correctly declares MIT
Licenses found in code but not declared in LICENSE: APACHE-2.0, BSD-3-CLAUSE, ISC, UNKNOWN-LICENSE-REFERENCE
💡 How to fix
📄 LICENSE.txt
Suggested fix
Document all third-party licences found in the codebase in the NOTICE file.
0/1
passed
1 warnings
Not in AUTHORS file or README
💡 How to fix
Suggested fix
Create an AUTHORS file or add an "Authors" section to README.md.
2/9
passed
1 failed
6 warnings
Project name not clearly detected in CHANGELOG
💡 How to fix
📄 CHANGELOG.md
Suggested fix
Add the project name as a heading at the top of CHANGELOG.md.
Version entries detected in CHANGELOG
📄 CHANGELOG.md
Version + date pattern detected in CHANGELOG
📄 CHANGELOG.md
No Added section in CHANGELOG
💡 How to fix
📄 CHANGELOG.md
Suggested fix
Add an "### Added" subsection listing new features in each release.
No Changed section in CHANGELOG
💡 How to fix
📄 CHANGELOG.md
Suggested fix
Add a "### Changed" subsection describing modifications to existing functionality.
No Deprecated section in CHANGELOG
📄 CHANGELOG.md
No Removed section in CHANGELOG
📄 CHANGELOG.md
No Fixed section in CHANGELOG
💡 How to fix
📄 CHANGELOG.md
Suggested fix
Add a "### Fixed" subsection listing bug fixes.
No Security section in CHANGELOG
💡 How to fix
📄 CHANGELOG.md
Suggested fix
Add a "### Security" subsection when security vulnerabilities were addressed.
0/1
passed
1 failed
Not in CONTRIBUTING file or README
💡 How to fix
Suggested fix
Create a CONTRIBUTING.md or add a "Contributing" section to README.md.
2/2
passed
No binary files detected
No large files detected (>= 10485760 bytes)