Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
89 lines (54 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

89 lines (54 loc) · 2.39 KB

🤝 Contributing to HistAgent

Thank you for your interest in contributing to HistAgent! Your involvement helps improve our project and fosters a collaborative community. This guide outlines how to contribute effectively.

📘 About HistAgent

HistAgent is a domain-specific, multimodal, multilingual agent designed for rigorous historical reasoning. It integrates specialized tools for OCR, translation, literature search, and visual analysis to process diverse historical sources.

🛠️ How to Contribute

1. Fork the Repository

Click the "Fork" button at the top-right corner of the HistAgent repository to create your own copy.

2. Clone Your Fork

git clone https://github.com/your-username/HistAgent.git
cd HistAgent

3. Create a New Branch

git checkout -b feature/your-feature-name

4. Make Changes

Implement your feature or fix, ensuring adherence to the project's coding standards.

5. Commit Your Changes

git add .
git commit -m "Brief description of your changes"

6. Push to Your Fork

git push origin feature/your-feature-name

7. Submit a Pull Request

Navigate to your fork on GitHub and click "Compare & pull request." Provide a clear description of your changes and submit.

🧪 Types of Contributions

We welcome various contributions, including but not limited to:

  • New Features: Enhance HistAgent's capabilities by adding new functionalities.
  • Bug Fixes: Identify and fix issues to improve stability.
  • Documentation: Improve clarity and comprehensiveness of documentation.
  • Tests: Add or improve test coverage to ensure reliability.
  • Data Contributions: Expand HistBench with new, well-formatted historical questions.

📝 Guidelines

  • Coding Standards: Follow PEP 8 for Python code.
  • Commit Messages: Use clear and descriptive messages.
  • Pull Requests: Ensure your PR is focused on a single topic or fix.
  • Testing: Run existing tests and add new ones as necessary.
  • Documentation: Update or add documentation for any changes made.

📄 Code of Conduct

Please adhere to our Code of Conduct to maintain a welcoming and respectful community.

📬 Contact

For questions or support, please open an issue in the repository.

Thank you for contributing to HistAgent!