Cordis Community Support: GitHub Issues, Documentation, and Contributing Guide
Cordis provides community support primarily through GitHub Issues, where developers can report bugs, request features, and ask questions, supplemented by the official Cordis Primer documentation.
The cordiverse/cordis repository centralizes all community interaction through GitHub, making it the single destination for technical support and contributions. Whether you encounter a bug in the framework or need architectural guidance, the project channels all Cordis community support through its issue tracker and documentation.
GitHub Issues as the Primary Support Channel
Cordis standardizes its support infrastructure across its monorepo structure by declaring GitHub Issues as the canonical communication channel. Each package within the repository explicitly lists the Issues URL in its package.json metadata.
In packages/utils/package.json, the bugs.url field points to the GitHub Issues tracker, establishing this as the official venue for community interaction. This configuration pattern is consistent across all Cordis packages, including packages/timer/package.json, packages/logger-console/package.json, and packages/loader/package.json, ensuring developers can open tickets from any package context and reach the same support system.
How to Report Bugs and Request Features
When you need to report unexpected behavior or propose new features, open an Issue in the cordiverse/cordis repository. You can interact with the Issues system through the GitHub web interface or programmatically via the GitHub CLI.
# Create a new issue titled "Example bug" with a description
gh issue create --title "Example bug" \
--body "Steps to reproduce:\n1. ...\n2. ...\nExpected behavior: ..."
The gh CLI interacts with the same GitHub Issues URL referenced in the package manifests, providing a command-line alternative to the web-based workflow.
Official Documentation Resources
Beyond issue tracking, Cordis maintains the Cordis Primer as its official documentation source. According to the repository's README.md, this documentation provides comprehensive guidance for getting started with the framework and understanding its core concepts.
Access the primer through the link provided in the root README.md to find setup instructions, architectural overviews, and usage patterns before opening support requests.
Contributing Code and Improvements
Active community members can contribute patches, documentation fixes, and new features by opening pull requests against the cordiverse/cordis repository. The GitHub platform hosts the entire contribution lifecycle, from initial pull request submission through code review and merge.
Because the project is under active development, the repository serves as the hub for both community support and collaborative development. No external chat platforms (such as Discord or Slack) are referenced in the source code, reinforcing GitHub as the sole authoritative channel for all interactions.
Summary
- GitHub Issues is the primary Cordis community support channel, linked in every package's
package.json. - Issue URLs are standardized across the monorepo in files such as
packages/utils/package.jsonandpackages/loader/package.json. - The Cordis Primer provides official documentation for getting started and troubleshooting.
- Contributions flow through GitHub pull requests using the same platform as support requests.
Frequently Asked Questions
Where can I get help with Cordis?
You can obtain support by opening a GitHub Issue in the cordiverse/cordis repository. Each package's package.json file contains the direct Issues URL, making it easy to find the support channel from any installation context.
Does Cordis have a Discord or Slack community?
Based on the repository source code, Cordis does not currently maintain external chat platforms like Discord or Slack. All community support is intentionally centralized through GitHub Issues to keep technical discussions searchable and accessible.
How do I report a bug in Cordis?
Report bugs by creating a new GitHub Issue with a clear reproduction case. You can use either the GitHub web interface or the gh issue create command from the GitHub CLI to submit your report, as shown in the examples above.
Where is the official Cordis documentation?
The official documentation is called the Cordis Primer, which is linked in the root README.md file of the repository. This resource contains getting-started guides and detailed explanations of the framework's architecture.
Have a question about this repo?
These articles cover the highlights, but your codebase questions are specific. Give your agent direct access to the source. Share this with your agent to get started:
curl -s "https://instagit.com/install.md" Maintain an open-source project? Get it listed too →