Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions .gitmodules

This file was deleted.

70 changes: 70 additions & 0 deletions docs/source/developers/repository_standards.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
Repository Standards
====================

This document outlines the standards and best practices for LizardByte repositories to ensure consistency,
maintainability, and quality across all projects.

Repository Structure
--------------------

File Organization
~~~~~~~~~~~~~~~~~

All repositories should follow a consistent structure:

.. code-block:: text

repository-name/
├── .github/
│ ├── matchers/ # custom problem matchers
│ ├── workflows/
│ │ ├── _codeql.yml
│ │ └── _common-lint.yml
│ ├── dependabot.yml
│ └── semantic.yml
├── branding/ # project specific branding assets
├── docs/ # structure varies depending on the doc system used
├── src/ # main source code
├── tests/ # if there are tests
├── third-party/ # location of submodules if any
├── .gitignore
├── LICENSE
└── README.md or README.rst

Required Files
~~~~~~~~~~~~~~

Every repository must include:

- **LICENSE**: All projects must use an appropriate license
- **README**: Primary documentation in reStructuredText (.rst) or Markdown (.md) format
- **.gitignore**: Appropriate for the project's language and framework.
See `GitHub's collection <https://github.com/github/gitignore>`_ for starter templates.
- **.github/**: Contains GitHub-specific configurations (workflows, issue templates, etc.)

Naming Conventions
------------------

Repository Names
~~~~~~~~~~~~~~~~

- Be descriptive and concise
- Avoid abbreviations unless widely understood

Branch Names
~~~~~~~~~~~~

- Use descriptive names with forward slashes for organization
- Format: ``type/short-description``
- Types: ``feat/``, ``fix/``, ``docs/``, ``refactor/``:
see `Convential Commits <https://www.conventionalcommits.org/en/v1.0.0/>`_ for a full list
- Examples: ``feat/user-authentication``, ``fix/memory-leak``, ``docs/api-reference``

File and Directory Names
~~~~~~~~~~~~~~~~~~~~~~~~

- Be consistent within each project
- Avoid spaces and special characters

For questions about these standards or exceptions,
please open an issue in the `.github <https://github.com/LizardByte/.github>`_ repository or contact the maintainers.
1 change: 1 addition & 0 deletions docs/source/toc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@

developers/code_of_conduct
developers/contributing
developers/repository_standards
1 change: 0 additions & 1 deletion gitignore
Submodule gitignore deleted from b19bb5