Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (41 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

57 lines (41 loc) · 2.82 KB

Contributing to ECLIPSE 🌟

Thank you for your interest in contributing to the ECLIPSE Project! By joining forces, we can make a real impact in the fight against infectious diseases. This document outlines how you can get involved and contribute effectively.

How You Can Contribute 🤝

We welcome contributions from a variety of fields and skill levels. Here are some ways you can help:

1. Report Issues 🐞

Found a bug, inconsistency, or something that needs improvement? Please submit an issue with detailed information so we can address it promptly.

2. Suggest Features 💡

Have an idea for a new feature, tool, or improvement? We’d love to hear it! Submit your ideas in the issues section with a clear description of the problem it solves.

3. Code Contributions 💻

If you’d like to write code for ECLIPSE:

  • Check out the open issues and look for labels like help wanted or good first issue.
  • Fork the repository and create a new branch for your feature or bugfix.
  • Submit a pull request (PR) with a clear explanation of your changes.

4. Documentation 📚

Improving the documentation is just as important as writing code! Whether it's clarifying existing content, adding tutorials, or translating the docs into other languages, your help is appreciated.

5. Outbreak Analytics and Disease Modeling (OADM) 📊

If you’re an expert in outbreak analytics or disease modeling, we’d love to collaborate on building or refining models. Feel free to share data, research insights, or modeling approaches.

6. Testing 🔍

Help us ensure the project is stable and functional:

  • Write unit tests.
  • Perform manual testing and provide feedback.

Guidelines 📝

Code of Conduct

Please adhere to our Code of Conduct to create a respectful and collaborative environment.

Coding Standards

  • Follow the style guide outlined for the project.
  • Write clear, maintainable, and well-documented code.
  • Test your changes before submitting a PR.

Pull Request Process

  1. Fork the repository and clone your fork locally.
  2. Create a new branch for your contribution: git checkout -b feature/your-feature-name.
  3. Make your changes and commit them: git commit -m "Add your descriptive commit message here".
  4. Push your changes: git push origin feature/your-feature-name.
  5. Open a pull request and provide a clear description of your changes.

Need Help? 🤔

If you’re unsure where to start or have any questions, feel free to:

We’re thrilled to have you on board and can’t wait to see how your contributions will help shape the future of the ECLIPSE Project! 🚀