Skip to content

Commit 85df853

Browse files
committed
docs: add leadership, involvement, limitations, and attribution sections to README
1 parent 7feb559 commit 85df853

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

README.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ Enterprise COBOL codebases are often large, undocumented, and hard to modernize.
1818
> **Note:**
1919
> This is the `main` branch. It currently uses a single-threaded Go CLI and separate Rust parser/summarizer binaries. **Unified backend and concurrency are available on the [`feat/concurrency-worker-pool`](https://github.com/Cod-e-Codes/codesleuth/tree/feat/concurrency-worker-pool) branch and will be merged soon.**
2020
21+
> **Concurrency/worker pool is in progress and NOT yet on `main`. If you want to help or test, please join the [feature branch](https://github.com/Cod-e-Codes/codesleuth/tree/feat/concurrency-worker-pool) instead of starting a competing fork!**
22+
2123
---
2224

2325
## Features
@@ -130,21 +132,40 @@ CodeSleuth works out-of-the-box. It automatically detects COBOL files (`.cob`, `
130132

131133
---
132134

133-
## Contributing
135+
## How to Get Involved
134136

135-
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on code style, testing, pull requests, and issue reporting.
137+
- ⭐ Star the repo to show support.
138+
- 🧪 Try the tool on your COBOL codebase and [open an issue](https://github.com/Cod-e-Codes/codesleuth/issues) with feedback.
139+
- 🛠️ For concurrency/back-end improvements, comment on or join the feature branch discussion.
140+
- 📚 See [CONTRIBUTING.md](CONTRIBUTING.md) for coding standards and PR steps.
136141

137142
---
138143

139-
## Security
144+
## Known Limitations
140145

141-
If you discover a security vulnerability, please see [SECURITY.md](SECURITY.md) for responsible disclosure guidelines.
146+
- Current release is single-threaded; large codebases may process slowly until concurrency lands in `main`.
147+
- Some COBOL dialects or edge-case constructs may not be fully supported—please report any parsing issues.
142148

143149
---
144150

145-
## License
151+
## Roadmap & Future Enhancements
152+
153+
- **Unified Backend & Concurrency:** Planned for the next release (see feature branch for early access)
154+
- **Configurable Output:** More options for customizing report formats and output destinations.
155+
- **Plugin System:** Extensible architecture for custom analysis or reporting plugins.
156+
- **Improved Error Handling:** More robust diagnostics and user feedback for parsing and analysis errors.
157+
- **Performance Benchmarks:** Publish real-world benchmarks as the tool matures.
158+
- **CI/CD Integration:** Enhanced support for integration with CI/CD pipelines and code quality gates.
159+
160+
## Author & Project Direction
161+
162+
CodeSleuth is actively led and maintained by [your name/GitHub handle]. Major architectural changes (such as the concurrency backend) are planned and documented—see the Roadmap and [feature branch](https://github.com/Cod-e-Codes/codesleuth/tree/feat/concurrency-worker-pool). Community contributions are welcome; please open issues or discussions for significant proposals.
163+
164+
---
165+
166+
*Built for maintainers and developers working with legacy COBOL systems.*
146167

147-
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
168+
This project is released under the MIT License; please credit the original author in any forks or derivative works.
148169

149170
---
150171

0 commit comments

Comments
 (0)