Skip to content

Latest commit

 

History

History
89 lines (59 loc) · 4.27 KB

CONTRIBUTING.md

File metadata and controls

89 lines (59 loc) · 4.27 KB
Raw

Contributing to LakeSoul

This project welcomes contributors from any organization or background, provided they are willing to follow the simple processes outlined below, as well as adhere to the Code of Conduct.

Joining the community

The community collaborates primarily through GitHub and the instance messaging tool, Slack. There is also a mailing list. See how to join here

Reporting an Issue

Please use the issues section of the LakeSoul repository and search for a similar problem. If you don't find it, submit your bug, question, proposal or feature request.

Use tags to indicate parts of the LakeSoul that your issue relates to. For example, in the case of bugs, please provide steps to reproduce it and tag your issue with bug and integration that has that bug, for example spark or flink.

Contributing to the project

Creating Pull Requests

Before sending a Pull Request with significant changes, please use the issue tracker to discuss the potential improvements you want to make.

LakeSoul uses GitHub's fork and pull model to create a contribution.

To ensure your pull request is accepted, follow these guidelines:

  • All changes should be accompanied by tests
  • Do your best to have a well-formed commit message for your change
  • Do your best to have a well-formed pull request description for your change
  • Keep diffs small and self-contained
  • If your change fixes a bug, please link the issue in your pull request description
  • Your pull request title should be of the form [component] name, where [component] is the part of LakeSoul repo that your PR changes. For example: [Flink] add table source implementation
  • Use tags to indicate parts of the repository that your PR refers to

Branching

  • Use a group at the beginning of your branch names:

    feature  Add or expand a feature
bug      Fix a bug

    For example:

    feature/my-cool-new-feature
bug/my-bug-fix
bug/my-other-bug-fix

  • Choose short and descriptive branch names

  • Use dashes (-) to separate words in branch names

  • Use lowercase in branch names

Proposing changes

Create an issue and tag it as proposal.

In the description provide the following sections:

  • Purpose (Why?): What is the use case this is for.
  • Proposed implementation (How?): Quick description of how do you propose to implement it. Are you proposing a new facet?

This can be just a couple paragraphs to start with.

Issue that could be splitted into several tasks should be tagged as epic.

First-Time Contributors

If this is your first contribution to open source, you can follow this tutorial or check out this video series to learn about the contribution workflow with GitHub.

Look for tickets labeled 'good first issue' and 'help wanted'. These are a great starting point if you want to contribute. Don't hesitate to ask questions about the issue if you are not sure about the strategy to follow.

Triggering CI runs from forks (committers)

CI runs on forks are disabled due to the possibility of access by external services via CI run. Once a contributor decides a PR is ready to be checked, they can use this script to trigger a CI run on a separate branch with the same commit ID. This will update the CI status of a PR.