CONTRIBUTING.md

Contributing to the registry

Thanks for your interest in using Community Lorebooks subdomain service and/or helping to maintain the registry data.

Pre-requisites / Pre-flight Checks

• By contributing, you agree to abide by the Code of Conduct and the Linux Developer Certificate of Origin (DCO).
• Review the AUP and subdomain terms of use before setting or updating one.

Components for beginners

Each component has its own documentation here in the registry monorepo and linked here for convenience:

• DNS records zonefile - the heart of this repository, used by octoDNS
• Subdomain registry data - manually-maintained YAML files for lorebooks.wiki and stellapent.wiki subdomains
• Community Lorebooks API - the API for the registry data, among other things. (api docs)

General contributing steps

1. Create your fork to easily publish your branches and send patches easily. (optional if you're going through the Git email flow).
2. Create a branch seperate from the main branch to keep things organized. While the project maintainers usually commit directly to the main branch, we recommend creating a branch for your changes to avoid conflicts.
3. Start hacking around. :)