Welcome to the Hyper Database Optimization and Integration project! This project is focused on contributing to Salesforce's next-gen database technology, Hyper, which is designed for high-performance transactional and analytical workloads. Below you will find the project structure and guides to help you get started.
- Introduction
- Project Structure
- Setup Guide
- Development Guide
- Testing Guide
- Deployment Guide
- Contribution Guide
- License
This project involves:
- Developing and optimizing database algorithms.
- Integrating new programming languages into APIs.
- Enhancing cloud-native deployments using Kubernetes.
- Collaborating with a distributed team to scale out Hyper Database capabilities.
To set up the project, refer to the Setup Guide in the guides/setup folder. This guide provides detailed instructions on:
- System requirements
- Cloning the repository
- Installing dependencies
- Setting up the development environment
For instructions on contributing to the codebase, please refer to the Development Guide located in the guides/development folder. This guide covers:
- Code structure and standards
- How to implement new features
- Integrating APIs and new programming languages
- Best practices for code optimization
To ensure the stability and performance of your contributions, follow the Testing Guide in the guides/testing folder. This guide includes:
- Running unit tests
- Integration testing with cloud platforms
- Performance benchmarking
- Testing for compatibility across different environments
Deployment instructions are available in the Deployment Guide in the guides/deployment folder. It provides details on:
- Setting up the cloud environment (Kubernetes, Docker)
- Deploying microservices to the cloud
- Continuous integration and continuous deployment (CI/CD) setup
We welcome contributions! Please read the Contribution Guide in the guides/contribution folder before starting. This guide outlines:
- How to propose new features
- Coding guidelines and code review process
- How to report issues and request features
- Git workflow (branching, committing, and pushing changes)