diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..938fcbd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing + +Thank you for your interest in contributing to the Profilarr Schema! This schema +serves as the foundation for all Profilarr Compliant Databases, so stability and +careful consideration of changes is critical. + +## Before Contributing + +**ALL contributions must be discussed before submitting a pull request.** This +is not negotiable. The schema affects every PCD and Profilarr installation, so +changes have far-reaching consequences. + +### Discussion Channels + +Please use one of the following channels to propose changes: + +- **Discord**: [Join our Discord server](https://discord.gg/XGdTJP5G8a) for + real-time discussion +- **GitHub Issues**: + [Open an issue](https://github.com/Dictionarry-Hub/schema/issues) for + structured proposals + +### What to Include in Your Proposal + +When proposing a change, please provide: + +1. **The problem**: What limitation or issue does this address? +2. **The solution**: What specific schema change are you proposing? +3. **Impact analysis**: How does this affect existing PCDs and Profilarr + installations? +4. **Migration path**: How would existing databases adapt to this change? diff --git a/README.md b/README.md index 3195cc6..946a240 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,19 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -# Profilarr Base Schema +# Schema This repository hosts the base schema applied to all [Profilarr Compliant Databases](https://dictionarry.dev/profilarr-setup/linking?section=the-open-standard) ## Documentation -- [Manifest Specification](docs/manifest.md) - Required manifest file format for - all PCDs +- [PCD Manifest Specification](docs/manifest.md) - Required manifest file format + for all PCDs + +## Contributing + +Please read [CONTRIBUTING.md](CONTRIBUTING.md) before proposing changes. All +contributions must be discussed before submission. ## Changelog diff --git a/base/0.initial.sql b/schema/0.initial.sql similarity index 100% rename from base/0.initial.sql rename to schema/0.initial.sql