Contributing
The Xapiand project welcomes, and depends, on contributions from developers and users in the open source community. Contributions can be made in a number of ways, a few examples are:
- Code patches via pull requests
- Documentation improvements
- Bug reports and patch reviews
Everyone interacting in the Xapiand project’s development, be it codebases, issue trackers, chat rooms, and mailing lists is expected to follow the Code of Conduct.
The Road Ahead
This is a To Do list of features that are only partially implemented; but that are planned to be supported by Xapiand some time soonish in order to get closer to the final product:
- Multi-Partitioning and Distribution Strategies:
- Random Consistent Partitioning and Replication.
- Highly Available:
- Automatic node operation rerouting.
- Replicas exists to maximize high availability and data locality.
- Read and Search operations performed on any of the replicas.
- Reliable, asynchronous replication for long term persistency.
Multi-Partitioning and Distribution Strategies
To achieve high availability, distribution of data and data locality, Xapiand can partition, replicate and distribute indexes across several nodes using any of the following partitioning strategies:
Random Consistent Partitioning
- Horizontal scaling by distributing indexes among several nodes.
- Increases data locality by increasing number of read-only replicas.
- Minimizes network usage when accessing indexes locally available.
Reporting an Issue
Please include as much detail as you can in the GitHub Issue. Let us know your platform and Xapiand version. If you get an error please include the full error and traceback when available.
Submitting Pull Requests
Once you are happy with your changes or you are ready for some feedback, push it to your fork and send a pull request. For a change to be accepted it will most likely need to have tests and documentation if it is a new feature.
Hack the source code
If you feel adventurous, you can hack the source code of Xapiand. You can find information about how to build from the sources here.