contributing.md

🚀 Contributing to EMScribe

Welcome to the contributing guide for EMScribe! This guide provides instructions for setting up the development environment, adding new features, writing tests, and maintaining documentation. Let's make EMScribe even better together!

🛠️ Setting Up the Development Environment

Follow the steps in the Development Guide to set up your development environment. Ensure you are familiar with the new CLI module and understand the piping feature for chaining commands.

📋 Dependencies

Ensure you have the following dependencies installed:

• Python 3.8 or higher
• Virtual Environment (venv)

Install the required dependencies:

pip install -r requirements.txt

📂 Directory Structure

Ensure you are familiar with the updated project directory structure:

.
|-- README.md
|-- bin
|   `-- emscribe
|-- commands
|   |-- clean_command.py
|   |-- extract_command.py
|   |-- generate_command.py
|   `-- review_command.py
|-- data
|   |-- cleaned_transcript.txt
|   |-- extract.txt
|   |-- narrative.txt
|   `-- reviewed_extract.txt
|-- docs
|   |-- api_reference
|   |   |-- extract_reviewer.md
|   |   |-- index.md
|   |   |-- model_loader.md
|   |   |-- narrative_manager.md
|   |   |-- prompt_manager.md
|   |   |-- transcript_cleaner.md
|   |   `-- transcript_extractor.md
|   |-- contributing.md
|   |-- development.md
|   |-- index.md
|   |-- installation.md
|   `-- usage.md
|-- images
|   `-- emscribe_logo.png
|-- modules
|   |-- extract_reviewer.py
|   |-- model_loader.py
|   |-- narrative_manager.py
|   |-- prompt_manager.py
|   |-- prompts
|   |   |-- cleaning_prompts.py
|   |   |-- extraction_prompts.py
|   |   |-- narrative_prompts.py
|   |   `-- review_prompts.py
|   |-- transcript_cleaner.py
|   `-- transcript_extractor.py
|-- requirements.txt
|-- scripts
|   |-- cli.py
|-- tests
|   |-- conftest.py
|   |-- test_cli.py
|   |-- test_model_loader.py
|   |-- test_review_command.py
|   |-- test_transcript_cleaner.py
|   `-- test_transcript_extractor.py
|-- transcript.txt
`-- venv

🌟 Adding New Features

Currently, I am not looking for contributors. However, if you have any requests or suggestions, feel free to contact me.

📧 Contact

For any questions or support, please contact ScottSucks.

🎉 Conclusion

Following these guidelines will help maintain the quality and consistency of the EMScribe codebase. For any questions or support, please contact ScottSucks.