#
Repository
Outdated
Essential considerations for creating new repositories or reviewing existing ones, organized by sections matching GitHub repository settings.
#
Hosting
Repositories are hosted on the GitHub platform under the develit-io organization. If not stated otherwise, the repository should remain private. When creating a new repository, do not add the files through the native initialization feature as the content should be scaffolded using the Develit CLI.
Exception
Some clients contractually require maintaining source code under their organization. In this case, repositories are created and maintained under that specific organization. All the following conventions apply, if not stated otherwise.
#
Naming
Maintaining consistent naming across all projects ensures that once a development workflow is learned, it can be easily transferred to any other project without confusion.
#
Repository
Repository Settings > General
Repository names should clearly indicate the project they belong to. Always include the project name in the repository name, and ensure this remains the sole component of the name. The complete name must follow kebab-case formatting.
Consider a project named Runeterra, which represents a robust SaaS solution that operates under a monorepository structure. The correct repository name would be simply runeterra. Given the absence of additional related repositories, there is no need to elaborate on the project nature further.
✅ runeterra
❌ runeterra-mono
❌ runeterra-project
❌ project
❌ project-runeterra
Expanding this further, consider a request to create a CLI for this project that should not be part of the monorepository. The correct repository name would be runeterra-cli while the original repository name would remain untouched.
✅ runeterra-cli
❌ cli
❌ cli-runeterra