Skip to content

Latest commit

 

History

History
62 lines (51 loc) · 2.72 KB

CONTRIBUTING.md

File metadata and controls

62 lines (51 loc) · 2.72 KB
Raw

Contributing to Linear Fox | GenoFusion

We are excited that you are interested in contributing to GenoFusion! By contributing, you help improve the tools and resources available to the bioinformatics community. Below are the guidelines for contributing to the project.

Table of Contents

  1. Getting Started
  2. How to Contribute
  3. Code of Conduct
  4. Community
  5. License

Getting Started

Follow installation from the README.md file to set up your environment and get started with GenoFusion.

How to Contribute

Reporting Bugs

  • If you encounter a bug, please open an issue on GitHub. Include as much detail as possible, such as:
  • Steps to reproduce the bug
  • Expected and actual behavior
  • Screenshots, if applicable
  • Environment details (operating system, Python version, etc.)

Suggesting Enhancements

We welcome suggestions for improvements. If you have an idea for a new feature or enhancement, please open an issue on GitHub. Provide a clear and concise description of the proposed enhancement, including any relevant context or benefits.

Submitting Pull Requests

  1. Ensure your changes align with the project’s goals and guidelines.
  2. Create a new branch for your changes:
git checkout -b feature/your-feature-name
  1. Make your changes, ensuring that your code is well-documented and tested.
  2. Commit your changes with a descriptive commit message:
  3. Push your branch to your forked repository
  4. Open a pull request on GitHub with a clear description of your changes.

Code of Conduct

We expect all contributors to adhere to the Code of Conduct when participating in the GenoFusion project.

Style Guides

Python Style Guide

  • Follow PEP 8 for Python code.
  • Ensure your code is well-documented with docstrings.
  • Use type annotations where appropriate.

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Capitalize the first letter of the message.
  • Limit the subject line to 50 characters.
  • Include a body if the message needs more explanation, wrapping at 72 characters.

Community

Join our community to discuss ideas, ask questions, and share feedback:

License

By contributing to GenoFusion, you agree that your contributions will be licensed under the Apache License 2.0.

Thank you for your interest in contributing to GenoFusion! Your contributions are valuable and appreciated.