diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 9db0b4570b4..e8ad4e845f8 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -75,6 +75,7 @@ * [Community](open-source-community/community.md) * [Developer](open-source-community/developer/README.md) + * [How to Contribute](open-source-community/developer/how-to-contribute.md) * [Coding Style](open-source-community/developer/coding-style.md) * [Build the code & run tests](open-source-community/developer/build-code-run-tests.md) * [Build a Connector](open-source-community/developer/build-a-connector/README.md) diff --git a/docs/open-source-community/developer/how-to-contribute.md b/docs/open-source-community/developer/how-to-contribute.md new file mode 100644 index 00000000000..82824c0cb0e --- /dev/null +++ b/docs/open-source-community/developer/how-to-contribute.md @@ -0,0 +1,56 @@ +# How to Contribute + +Welcome to [OpenMetadata](https://open-metadata.org). Our goal is to build an Open standard for Metadata. +We truly believe this can only be achieved through building a great community. + +We ❤️ all contributions, big and small! + +## Github issues + +Look for issues under [github/issues tab](https://github.com/open-metadata/OpenMetadata/issues) . If you have a feature request or found a bug please file an issue first. + +![./images/new-issue.png](./images/new-issue.png) + + +## Fork Github project + +OpenMetadata github repository can be accessed here [https://github.com/open-metadata/OpenMetadata](https://github.com/open-metadata/OpenMetadata) . + +![./images/fork-github.png](./images/fork-github.png) + + +## Create a branch in your fork + +```bash +git checkout -b ISSUE-200 +``` + +Make changes. Follow the [Coding Style](./coding-style.md) Guide on best practices and [Build the code & run tests](./build-code-run-tests.md) on how to setup Intellij, Maven + + +## Push your changes to Github + +```bash +git add . +git commit -m "ISSUE-200: Meaningful commit message +git push origin HEAD:refs/heads/issue-200 +``` + + +## Open a PR + +1. Go to https://github.com/open-metadata/OpenMetadata/pulls + +2. It should show an option to open a pull request. + +3. If not click on "New Pull request" +![./images/pull-request.png](./images/pull-request.png) +4. Select your fork repository and branch +![./images/pull-request-2.png](./images/pull-request-2.png) + +5. Click "Create pull request" + + +## We are here to help + +Please reach out to us anytime you need any help. [Slack](https://openmetadata.slack.com/join/shared_invite/zt-udl8ris3-Egq~YtJU_yJgJTtROo00dQ#/shared-invite/email) would be fastest way to get a response. \ No newline at end of file diff --git a/docs/open-source-community/developer/images/fork-github.png b/docs/open-source-community/developer/images/fork-github.png new file mode 100644 index 00000000000..746a7514f94 Binary files /dev/null and b/docs/open-source-community/developer/images/fork-github.png differ diff --git a/docs/open-source-community/developer/images/new-issue.png b/docs/open-source-community/developer/images/new-issue.png new file mode 100644 index 00000000000..22a9a099e44 Binary files /dev/null and b/docs/open-source-community/developer/images/new-issue.png differ diff --git a/docs/open-source-community/developer/images/pull-request-2.png b/docs/open-source-community/developer/images/pull-request-2.png new file mode 100644 index 00000000000..91926941907 Binary files /dev/null and b/docs/open-source-community/developer/images/pull-request-2.png differ diff --git a/docs/open-source-community/developer/images/pull-request.png b/docs/open-source-community/developer/images/pull-request.png new file mode 100644 index 00000000000..a84f90ac520 Binary files /dev/null and b/docs/open-source-community/developer/images/pull-request.png differ