Code Contribution Guide

we would love for you to contribute to this project and help make it even better than it is today! as a contributor, here are the guidelines we would like you to follow code of conduct help us keep this community open and inclusive got a question or problem? do not open issues for general support questions, as we want to keep github issues for bug reports and feature requests instead, we recommend using " discussions https //github com/datalakehouse/datalakehouse core/discussions " to ask support related questions you can also email us at support\@datalakehouse io mailto\ support\@datalakehouse io found a bug? if you find a bug in the source code, you can help us by submitting an issue or even better, you can submit a pull request with a fix missing a feature? you can request a new feature by submitting an issue to our github repository contributor agreements individuals contributing to any of the projects will need to complete our contributor license agreement form submission guidelines submitting an issue before you submit an issue, please search the issue tracker maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available we want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it in order to reproduce bugs, we require that you provide a minimal reproduction having a minimal reproducible scenario gives us a wealth of important information, without going back and forth to you with additional questions a minimal reproduction allows us to quickly confirm a bug (or point out a coding problem), as well as confirm that we are fixing the right problem we require a minimal reproduction to save maintainers' time, which ultimately enables them to fix more bugs often, developers find coding problems themselves while preparing a minimal reproduction we understand that sometimes it might be hard to extract essential bits of code from a larger codebase, but we really need to isolate the problem before we can fix it unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you, we will close an issue that doesn't have enough info to be reproduced you can file new issues by selecting from our new issue templates and filling out the issue template submitting a pull request (pr) before you submit your pull request (pr), please consider the following guidelines search github https //github com/datalakehouse/datalakehouse core/pulls for an open or closed pr that relates to your submission you don't want to duplicate existing efforts be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add discussing the design upfront helps to ensure that we're ready to accept your work fork https //docs github com/en/github/getting started with github/fork a repo the datalakehouse/datalakehouse core repo in your forked repository, make your changes in a new git branch git checkout b my fix branch main create your patch, including appropriate test cases follow our coding rules run the full test suite, as described in the \[developer documentation]\[dev doc], and ensure that all tests pass commit your changes using a descriptive commit message that follows our \[commit message conventions]\(#commit) adherence to these conventions is necessary because release notes are automatically generated from these messages git commit all nb the optional commit a command line option will automatically "add" and "rm" edited files push your branch to github git push origin my fix branch in github, send a pull request to datalakehouse core\ community reviewing a pull request the maintainers team reserves the right not to accept pull requests from community members who haven't been good citizens of the community such behavior includes not following the code of conduct commit message format this specification is inspired by and supersedes the \[angularjs commit message format]\[commit message format] we have very precise rules over how our git commit messages must be formatted this format leads to easier to read commit history each commit message header must conform to the commit message header format commit message header \<type> \<short summary> type must be one of the following build changes that affect the build system or external dependencies (example scopes gulp, broccoli, npm) ci changes to our ci configuration files and scripts (example scopes travis ci, github actions, circleci) docs documentation only changes feat a new feature fix a bug fix perf a code change that improves performance refactor a code change that neither fixes a bug nor adds a feature test adding missing tests or correcting existing tests short summary use the summary field to provide a succinct description of the change use the imperative, present tense "change" not "changed" nor "changes" don't capitalize the first letter no dot ( ) at the end if you have more than one github accounts, the following documents can help you sort out issues with github accounts and multiple email addresses