sw-metadata-bot

An automated bot that analyzes repository metadata quality and creates issues with improvement suggestions.

Part of the CodeMetaSoft project to improve research software metadata quality.

---

📋 What This Bot Does

If you received an issue from this bot, it means your repository's metadata was automatically analyzed and some improvements were detected.

The issue contains:

• Pitfalls: Critical metadata issues that should be fixed
• Warnings: Metadata improvements that are recommended
• Suggestions: Specific recommendations on how to fix each issue

Example Issues You Might See

• Missing or incomplete LICENSE file
• No CITATION.cff file (for software citation)
• Incomplete or missing README sections
• Missing repository metadata (topics, description, etc.)
• Outdated dependencies
• Missing software documentation

---

💬 How to Respond

If You Agree with the Suggestions

Fix the identified issues and close the issue with a comment explaining what you fixed. Your improvements help your software become more discoverable and citable!

If You Disagree or Have Questions

Feel free to comment on the issue. We're happy to discuss the suggestions and help clarify what's needed.

If You're Not Interested

Simply comment "unsubscribe" on the issue and we'll remove your repository from future analysis.

---

🔍 What Analysis Is Used

This bot uses RSMetaCheck, which analyzes:

• Software metadata completeness
• Citation and documentation quality
• Repository structure and best practices

The bot does not:

• Modify your code or files
• Make pull requests
• Have access to your repository secrets

---

📚 Learn More

• CodeMetaSoft Project - About the initiative
• RSMetaCheck - The analysis tool
• Citation File Format - How to add CITATION.cff

---

🛠️ For Maintainers Running This Bot

See QUICKSTART.md for setup and usage instructions.

Supported platforms:

• ✅ GitHub.com
• ✅ GitLab.com
• ✅ Self-hosted GitLab instances

---

📝 License

See LICENSE file.