Skip to content

Commit 411da2c

Browse files
committed
Add badges, SECURITY.md, requirements.txt, and CI workflow
1 parent e4d5d24 commit 411da2c

File tree

4 files changed

+74
-3
lines changed

4 files changed

+74
-3
lines changed

.github/workflows/ci.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- name: Set up Python
15+
uses: actions/setup-python@v4
16+
with:
17+
python-version: '3.8'
18+
- name: Install Python dependencies
19+
run: |
20+
pip install -r pytools/requirements.txt || pip install argparse
21+
- name: Lint Python
22+
run: |
23+
python -m py_compile pytools/summary.py
24+
- name: Set up Rust
25+
uses: actions/setup-rust@v1
26+
with:
27+
rust-version: 'stable'
28+
- name: Build Rust parser
29+
run: |
30+
cd parser && cargo build --release
31+
- name: Set up Go
32+
uses: actions/setup-go@v4
33+
with:
34+
go-version: '1.21'
35+
- name: Build Go CLI
36+
run: |
37+
cd cmd && go build -o codesleuth.exe

README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
# CodeSleuth
22

3-
**CodeSleuth** is a modern, multi-language code intelligence CLI tool focused on COBOL analysis. It combines a fast Rust parser, a Go CLI, and a Python Markdown summarizer to provide actionable, human-friendly reports for legacy codebases.
4-
53
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
4+
[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](CONTRIBUTING.md)
5+
[![Code of Conduct](https://img.shields.io/badge/code%20of%20conduct-Contributor%20Covenant-blueviolet.svg)](CODE_OF_CONDUCT.md)
6+
[![Issues](https://img.shields.io/github/issues/Cod-e-Codes/codesleuth.svg)](https://github.com/Cod-e-Codes/codesleuth/issues)
7+
[![Pull Requests](https://img.shields.io/github/issues-pr/Cod-e-Codes/codesleuth.svg)](https://github.com/Cod-e-Codes/codesleuth/pulls)
8+
[![Last Commit](https://img.shields.io/github/last-commit/Cod-e-Codes/codesleuth.svg)](https://github.com/Cod-e-Codes/codesleuth/commits/main)
9+
10+
---
11+
12+
**CodeSleuth** is a modern, multi-language code intelligence CLI tool focused on COBOL analysis. It combines a fast Rust parser, a Go CLI, and a Python Markdown summarizer to provide actionable, human-friendly reports for legacy codebases.
613

714
---
815

@@ -12,6 +19,8 @@
1219
- **Dead Code Detection:** Lists unused paragraphs and variables.
1320
- **Extensible Pipeline:** Modular Rust, Go, and Python components.
1421
- **Modern CLI:** Easy to use, with verbose/debug options.
22+
- **Security Policy:** See [SECURITY.md](SECURITY.md)
23+
- **Continuous Integration:** Automated tests and linting via GitHub Actions.
1524

1625
---
1726

@@ -31,7 +40,7 @@ cd codesleuth
3140

3241
Install Python dependencies:
3342
```sh
34-
pip install -r requirements.txt # (if you add one)
43+
pip install -r requirements.txt
3544
```
3645

3746
### 3. Build the Rust Parser
@@ -68,6 +77,18 @@ cd ..
6877

6978
---
7079

80+
## Security
81+
82+
If you discover a security vulnerability, please see [SECURITY.md](SECURITY.md) for responsible disclosure guidelines.
83+
84+
---
85+
86+
## Continuous Integration
87+
88+
This project uses GitHub Actions for automated testing and linting. See `.github/workflows/ci.yml` for details.
89+
90+
---
91+
7192
## Contributing
7293
Pull requests, issues, and suggestions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
7394

SECURITY.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you discover a security vulnerability in CodeSleuth, please report it responsibly:
6+
7+
- **Do not** open a public issue for security problems.
8+
- Email Cody Marsengill at [email protected] with details.
9+
- We will respond as quickly as possible and coordinate a fix.
10+
11+
Thank you for helping keep CodeSleuth and its users safe!

requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Python requirements for CodeSleuth summarizer
2+
argparse

0 commit comments

Comments
 (0)