GitHub

Open source collaboration and community development

Repository & Links

Access the source code and connect with the community

Main Repository

Source code, documentation, and project files

GitHub Stars
Forks
Watchers
View Repository

Issue Tracker

Report bugs, request features, and track development

Open Issues
Closed Issues
Milestones
Report Issues

Releases

Download stable releases and pre-built binaries

Latest Release
Release Date
Downloads
Download Releases

Contributing

Join our community and help improve BioMiner Indexd

How to Contribute

1
Fork the Repository

Create your own fork of the BioMiner Indexd repository on GitHub

2
Create a Branch

Create a feature branch for your changes: git checkout -b feature/your-feature

3
Make Changes

Implement your changes, add tests, and ensure code quality

4
Submit Pull Request

Create a pull request with a clear description of your changes

Development Setup

Prerequisites
  • Rust (latest stable version)
  • PostgreSQL (10.x or higher)
  • Node.js (for frontend development)
  • Git
Quick Setup
# Clone the repository
git clone https://github.com/yjcyxky/biominer-indexd.git
cd biominer-indexd

# Install dependencies
cargo build

# Run tests
make test

Areas for Contribution

Find your niche and make an impact

Backend Development

Improve the Rust backend, add new API endpoints, optimize database queries, and enhance performance.

Rust PostgreSQL API

Frontend Development

Enhance the React frontend, improve user experience, add new features, and optimize the interface.

React TypeScript Ant Design

AI Copilot

Improve the AI assistant, add new capabilities, enhance natural language processing, and expand knowledge base.

AI/ML NLP LLM

Data Management

Improve dataset handling, add new data formats, enhance validation, and optimize data processing pipelines.

Data Validation ETL

Documentation

Improve documentation, write tutorials, create examples, and help users understand the system better.

Docs Tutorials Examples

Testing

Write unit tests, integration tests, improve test coverage, and ensure code quality and reliability.

Testing Quality Coverage

Community Guidelines

Building a welcoming and productive community

Be Respectful

Treat all community members with respect and kindness. Constructive feedback is welcome, but personal attacks are not.

Be Helpful

Help others learn and grow. Share your knowledge, answer questions, and mentor new contributors.

Write Clean Code

Follow coding standards, write clear documentation, and ensure your code is maintainable and well-tested.

Communicate Clearly

Use clear, descriptive commit messages, issue titles, and pull request descriptions to help others understand your work.

License

Understanding our open source license

GNU Affero General Public License v3.0

BioMiner Indexd is distributed under the GNU Affero General Public License v3.0 (AGPL-3.0).

Key Points:
  • Freedom to Use: You can use, modify, and distribute the software
  • Source Code Access: You must provide access to the source code
  • Network Use: If you run a modified version on a server, you must provide source code to users
  • Compatibility: Works well with other open source licenses
Read Full License View on GitHub

Ready to Contribute?

Join our community and help build the future of omics data management. Every contribution, big or small, makes a difference.

Start Contributing Report Issues