Thank you for your interest in contributing to this project! We welcome contributions from the community to make this project better.
If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub Issue Tracker. If you'd like to submit a feature enhancement, please first create an issue with your proposed idea so that we can start a discussion about the problem you want to solve and what the best solution would be.
You can request a new feature by submitting an issue to our GitHub Issue Tracker. If you would like to implement a new feature then first create a new issue and discuss it with one of our project maintainers.
To get started with contributing, please follow these steps:
- Fork the repository and clone it to your local machine.
- Install the necessary dependencies.
- Create a new branch for your changes.
- Make your desired changes to the codebase.
- Test your changes thoroughly.
- Tests can be done using the test framework. See README
Created PR will not be merge as is. The MarkLogic docker team will use the PRs for "inspiration" but not merge the changes in directly. They may rewrite the code as they like, incorporating the submitted changes into their own code.
Important: Please open an issue in the Issue Tracker and get your proposed changes pre-approved by at least one of the project maintainers before you start coding. Nothing is more frustrating than seeing your hard work go to waste because your vision does not align with that of the project maintainers.