​
Contribution Guidelines for Saiku

We welcome contributions to Saiku from the community! Whether you’re fixing bugs, adding features, or improving documentation, your input is valuable. This guide outlines how you can contribute effectively to the Saiku project.

​
Getting Started

Before contributing, it’s important to familiarize yourself with the Saiku project. Spend some time understanding its architecture, coding standards, and current issues or feature requests.

​
Submitting Issues

If you encounter bugs or have feature requests, please submit them as issues on our GitHub repository. Be sure to include the following:
  • A clear and descriptive title.
  • A detailed description of the issue or feature request.
  • Steps to reproduce the issue (if applicable).
  • Any relevant screenshots or error messages.

​
Pull Requests

We encourage pull requests that improve the codebase or add beneficial features. Here’s how to create a pull request:

​
1. Fork the Repository

Fork the Saiku repository to your GitHub account and clone it to your local machine.

​
2. Create a Feature Branch

Create a new branch for your feature or fix: 
git checkout -b feature/YourFeatureName

​
3. Make Your Changes

Implement your changes in the feature branch, adhering to the existing coding standards and practices.

​
4. Commit and Push Your Changes

Commit your changes with a clear message describing the fix or feature. Then push the branch to your forked repository: 
git commit -m 'Add a detailed commit message'
git push origin feature/YourFeatureName

​
5. Create a Pull Request

Open a pull request against the main Saiku repository. Ensure your pull request description clearly explains the changes and reference any related issue numbers.

​
Code Review Process

Once you submit a pull request, it will be reviewed by the maintainers. Be open to feedback and willing to make revisions if necessary.
Keep your fork synchronized with the main repository to avoid merge conflicts. Regularly pull the latest changes from the upstream repository into your branch.

​
Best Practices for Contribution

  • Adhere to the coding standards and practices established in the project.
  • Write clean, readable, and well-documented code.
  • Include tests with your changes whenever possible.
  • Respect the community and other contributors. Collaboration is key!
Your contributions are instrumental in making Saiku better for everyone. We look forward to your innovative ideas and improvements!