Docs: How to contribute to OpenMetadata

This commit is contained in:
Suresh Srinivas 2021-08-18 10:47:35 -07:00
parent e04626cb1b
commit b633c80c0b
6 changed files with 57 additions and 0 deletions

View File

@ -75,6 +75,7 @@
* [Community](open-source-community/community.md) * [Community](open-source-community/community.md)
* [Developer](open-source-community/developer/README.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) * [Coding Style](open-source-community/developer/coding-style.md)
* [Build the code & run tests](open-source-community/developer/build-code-run-tests.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) * [Build a Connector](open-source-community/developer/build-a-connector/README.md)

View File

@ -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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 277 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 516 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1015 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 366 KiB