Skip to content

Add license scan report and status #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add license scan report and status #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# AIGitCommit

[![Cargo Build & Test](https://github.com/mingcheng/aigitcommit/actions/workflows/rust.yml/badge.svg?branch=main)](https://github.com/mingcheng/aigitcommit/actions/workflows/rust.yml)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmingcheng%2Faigitcommit.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmingcheng%2Faigitcommit?ref=badge_shield)

![screenshots](./assets/screenshots.png)

Expand Down Expand Up @@ -127,3 +128,6 @@ Contributions are welcome! Please feel free to submit a Pull Request.
This project is licensed under the MIT License - see the LICENSE file for details.

`- eof -`


[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmingcheng%2Faigitcommit.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmingcheng%2Faigitcommit?ref=badge_large)
Comment on lines 130 to +133
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Badge inserted after the declared “EOF” marker

- eof - signals the intended end of the document; content that follows may be overlooked in some renderers or confuse future editors. Move the large FOSSA badge above the marker (or drop the marker altogether).

-`- eof -`
-
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmingcheng%2Faigitcommit.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmingcheng%2Faigitcommit?ref=badge_large)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmingcheng%2Faigitcommit.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Faigitcommit?ref=badge_large)
+
+`- eof -`

Avoids violating the sentinel and keeps the README terminator meaningful.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
`- eof -`
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmingcheng%2Faigitcommit.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmingcheng%2Faigitcommit?ref=badge_large)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmingcheng%2Faigitcommit.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmingcheng%2Faigitcommit?ref=badge_large)
`- eof -`
🤖 Prompt for AI Agents 
In README.md around lines 130 to 133, the FOSSA badge is placed after the
declared EOF marker, which can cause it to be overlooked or confuse editors.
Move the entire FOSSA badge markdown line above the `- eof -` marker or remove
the EOF marker entirely to ensure the badge is properly rendered and the EOF
marker remains meaningful.