mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-08-14 12:06:54 +00:00
* Add CONTRIBUTING.md * Update README.md * Add ISSUE_TEMPLATE * Add sonar status
This commit is contained in:
parent
92d6e943db
commit
768aa310eb
29
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
29
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@ -0,0 +1,29 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**Affected module**
|
||||
Does it impact the UI, backend or Ingestion Framework?
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
|
||||
Screenshots or steps to reproduce
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Version:**
|
||||
- OS: [e.g. iOS]
|
||||
- Python version:
|
||||
- OpenMetadata version: [e.g. 0.8]
|
||||
- OpenMetadata Ingestion package version: [e.g. `openmetadata-ingestion[docker]==XYZ`]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
19
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
19
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@ -0,0 +1,19 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
7
CONTRIBUTING.md
Normal file
7
CONTRIBUTING.md
Normal file
@ -0,0 +1,7 @@
|
||||
# Contributors
|
||||
|
||||
We ❤️ all contributions, big and small!
|
||||
|
||||
Read [Build Code and Run Tests](https://docs.open-metadata.org/open-source-community/developer/build-code-run-tests) for how to setup your local development environment. Get started with our [Good first issues](https://github.com/open-metadata/OpenMetadata/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
|
||||
|
||||
If you want to, you can reach out via [Slack](https://openmetadata.slack.com/join/shared_invite/zt-wksh1bww-iQGk45NTw6Tp4Q9UZd6QOw#/shared-invite/email) or [email](mailto:dev@open-metadata.org) and we'll set up a pair programming session to get you started.
|
23
README.md
23
README.md
@ -1,8 +1,9 @@
|
||||
<div align="center">
|
||||
<img src="https://i.imgur.com/5VumwFS.png" align="center" alt="OpenMetadata" height="90"/>
|
||||
<img src="./docs/.gitbook/assets/openmetadata-banner.png" align="center" alt="OpenMetadata" height="350"/>
|
||||
<hr />
|
||||
|
||||
[](https://github.com/open-metadata/OpenMetadata/actions/workflows/maven-build.yml)
|
||||
[](https://sonarcloud.io/summary/new_code?id=open-metadata_OpenMetadata)
|
||||
[](https://github.com/open-metadata/OpenMetadata/releases)
|
||||

|
||||
[](https://twitter.com/intent/follow?screen_name=open_metadata)
|
||||
@ -12,6 +13,7 @@
|
||||
</div>
|
||||
|
||||
- [What is OpenMetadata?](#what-is-openmetadata )
|
||||
- [Features](#features)
|
||||
- [Try our Sandbox](#try-our-sandbox)
|
||||
- [Install & Run](#install-and-run-openmetadata)
|
||||
- [Roadmap](docs/roadmap.md)
|
||||
@ -34,9 +36,18 @@ OpenMetadata includes the following:
|
||||
|
||||
- **OpenMetadata User Interface** - one single place for users to discover, and collaborate on all data.
|
||||
|
||||
## Features
|
||||
|
||||
Check all the supported features [here](https://docs.open-metadata.org/features) ✨
|
||||
|
||||

|
||||
|
||||
## Try our Sandbox
|
||||
|
||||
Visit our demo at [http://sandbox.open-metadata.org](http://sandbox.open-metadata.org)
|
||||
Take a look and play with sample data at [http://sandbox.open-metadata.org](http://sandbox.open-metadata.org)
|
||||
|
||||
[<img src="./docs/.gitbook/assets/demo-button.png" height="50"/>](http://sandbox.open-metadata.org)
|
||||
|
||||
|
||||
## Install and run OpenMetadata
|
||||
Get up and running in few minutes. See the OpenMetadata documentation for [installation instructions](https://docs.open-metadata.org/install/run-openmetadata).
|
||||
@ -53,11 +64,13 @@ We're here to help - and make OpenMetadata even better!
|
||||
|
||||
## Contributors
|
||||
|
||||
We ❤️ all contributions, big and small!
|
||||
We ❤️ all contributions, big and small! Check out our [CONTRIBUTING](./CONTRIBUTING.md) guide to get started and let us know how we can help.
|
||||
|
||||
Read [Build Code and Run Tests](https://docs.open-metadata.org/open-source-community/developer/build-code-run-tests) for how to setup your local development environment. Get started with our [Good first issues](https://github.com/open-metadata/OpenMetadata/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
|
||||
Don't want to miss anything? Give the project a ⭐ 🚀
|
||||
|
||||
If you want to, you can reach out via [Slack](https://openmetadata.slack.com/join/shared_invite/zt-wksh1bww-iQGk45NTw6Tp4Q9UZd6QOw#/shared-invite/email) or [email](mailto:dev@open-metadata.org) and we'll set up a pair programming session to get you started.
|
||||
Big thanks to all of you who already support us!
|
||||
|
||||
[](https://github.com/open-metadata/OpenMetadata/stargazers)
|
||||
|
||||
## License
|
||||
OpenMetadata is released under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
|
||||
|
BIN
docs/.gitbook/assets/demo-button.png
Normal file
BIN
docs/.gitbook/assets/demo-button.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 3.9 KiB |
BIN
docs/.gitbook/assets/openmetadata-banner.png
Normal file
BIN
docs/.gitbook/assets/openmetadata-banner.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 390 KiB |
Loading…
x
Reference in New Issue
Block a user