.github

This is a meta-repository that defines some shared files for the repositories under the Nebari-dev organization.

📁 Files in this repository

Below is a quick list of what you'll find in this repository:

• .github/ISSUE_TEMPLATE/: Issue templates for other repositories. When these files are changed, they are automatically synced to our other repositories via this GitHub action.
• .github/PULL_REQUEST_TEMPLATE.md: Pull request templates for other repositories. When these files are changed, they are automatically synced to our other repositories via this GitHub action.
• LICENSE: All of our projects are under a BSD-3 clause license, this is automatically synced to our other repositories via this GitHub action.
• CONTRIBUTING.md: Base contributing guidelines for all of our projects, this is automatically synced to our other repositories via this GitHub action.

Warning The syncing action requires a Personal Authentication Token (PAT) which is currently set up through Nebari-sensei

🧹 Pre-commit hooks

This repository uses the prettier pre-commit hook to standardize our YAML and markdown structure. This ensures that when we sync files to other repositories, we do not create conflicts with prettier checks in each repository. To install and run it, use these commands from the repository root:

# install the pre-commit hooks
pre-commit install

# run the pre-commit hooks
pre-commit run --all-files

🔗 References

• See https://help.github.com/en/articles/creating-a-default-community-health-file-for-your-organization for more details