Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a contrib folder #46

Merged
merged 4 commits into from
Nov 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@
This repository provides Databricks Asset Bundles examples.

To learn more, see:
* The public preview announcement at
https://www.databricks.com/blog/announcing-public-preview-databricks-asset-bundles-apply-software-development-best-practices
* The launch blog post at https://www.databricks.com/blog/announcing-general-availability-databricks-asset-bundles
* The docs at https://docs.databricks.com/dev-tools/bundles/index.html
43 changes: 43 additions & 0 deletions contrib/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Contrib Directory

The `contrib` directory contains additional community-contributed examples and resources for Databricks Asset Bundles. These examples may include:

- Custom configurations and extensions
- Advanced usage patterns
- Tools or utilities for enhancing Databricks Asset Bundles workflows

## Structure

Each contribution should be organized into its own subdirectory within `contrib/`.
Templates should go under `contrib/templates/`. For example:

```
contrib/
├── awesome-bundle/
│ ├── README.md
│ ├── databricks.yml
│ └── ...
└── templates/
└── awesome-template/
├── README.md
├── databricks_template_schema.json
├── library/
│ └── ...
└── template/
└── ...
```

## How to Use Contributions

To use or explore a contributed example, navigate to its subdirectory and follow the instructions in its `README.md` file. Each example should provide details on setup, configuration, and usage.

## Contributing

If you would like to add your own examples or resources, please:
1. Create a new directory under `contrib/` with a descriptive name.
2. Include a `README.md` file explaining the contribution.
3. Ensure that any necessary configuration files, scripts, or dependencies are included.

For more information on Databricks Asset Bundles, see:
- The launch blog post at https://www.databricks.com/blog/announcing-general-availability-databricks-asset-bundles
- The docs at https://docs.databricks.com/dev-tools/bundles/index.html
10 changes: 10 additions & 0 deletions contrib/templates/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Contrib/Templates directory

This directory contains community-contributed templates.

See https://github.com/databricks/bundle-examples/blob/main/contrib/README.md to learn more
about community contributions.

Looking to contribute? See https://github.com/databricks/cli/tree/main/libs/template/templates
for inspiration. These are the standard templates that are included with the
Databricks CLI.