Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
90 lines (62 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

90 lines (62 loc) · 2.01 KB

Contributing to OpenLake Project

We welcome contributions of all kinds — code, documentation, testing, design, and ideas.
Please read this guide before contributing to ensure smooth collaboration.

1. Code of Conduct

All contributors are expected to follow our Code of Conduct to maintain a welcoming environment. All technical exchanges on Discord -https://discord.gg/tNcwTQ5Q43.

2. How to Contribute

Reporting Bugs

  • Search existing issues to avoid duplicates.
  • Use the Bug Report issue template.
  • Include:
    • Clear title and description
    • Steps to reproduce
    • Expected vs actual behavior
    • Screenshots/logs if applicable

Suggesting Features

  • Use the Feature Request issue template.
  • Provide:
    • The problem your feature solves
    • Proposed solution or design
    • Alternatives considered

Improving Documentation

  • Check for outdated or unclear sections.
  • Submit a PR with your changes, tagging it with the documentation label.

3. Development Workflow

  1. Fork the repository.

  2. Clone your fork:

    git clone https://github.com/<your-username>/your-project.git

  3. Create a branch for your work:

    git checkout -b feature/your-feature-name

  4. Commit changes using clear messages:

    git commit -m "Add: brief description of change"

  5. Push your branch:

    git push origin feature/your-feature-name

  6. Open a Pull Request:

    • Link related issues.
    • Follow the PR template.

4. Pull Request Guidelines

  • Keep PRs small and focused.
  • Include tests for new functionality.
  • Pass all CI checks before requesting a review.
  • Use clear commit messages.

5. Getting Help

If you’re stuck:

  • Check the README and existing issues.
  • Ask questions in the OpenLake Slack channel.
  • Tag a maintainer in your issue or PR.

Thank you for contributing to OpenLake! Every contribution — big or small — helps the project grow.