Skip to content

REPOSITORY-GUIDELINES.md

Latest commit

 

History

History
56 lines (33 loc) · 3.37 KB

REPOSITORY-GUIDELINES.md

File metadata and controls

56 lines (33 loc) · 3.37 KB

Repository Guidelines

This document describes the scope and lifecycle of repositories in the Dragonfly project. You can find all repositories by scope in REPOSITORIES.md.

And this document is inspired from the Cilium project's repository guidelines. We appreciate the Cilium community for their excellent work.

Table of Contents

Repositories Scope

Each repository in the Dragonfly GitHub organization is assigned one of three scopes: Core, Ecosystem, or Historical. The scope helps explain the role and responsibility of each repository in the project.

Core Repositories

Core repositories are the most important part of the Dragonfly project. They provide the main and essential features. These repositories are the most active and are used most often by users.

You can find all Core repositories in REPOSITORIES.md.

Ecosystem Repositories

Ecosystem repositories are the most numerous. This scope is broad on purpose. These repositories have different levels of maturity and activity. Users should carefully check before using any end-user-facing repositories in this scope.

You can find all Ecosystem repositories in REPOSITORIES.md.

Historical Repositories

Historical repositories are considered deprecated and are no longer maintained. They are usually archived as read-only. Users are not advised to use these repositories.

Repositories that have not been active for a long time can be proposed for archiving. The process is the same as other scope changes. You can find all Historical repositories in REPOSITORIES.md.

Repositories Lifecycle

Add a Repository

New repositories can be proposed by Maintainers through creating an issue in the community repository. The proposal process must follow the decision-making rules in COMMUNITY_MEMBERSHIP.md. This includes creating new repositories, accepting donated repositories, or creating forks from existing repositories.

Once approved through the community voting process, the new repository must be added to the appropriate list in REPOSITORIES.md.

Change of Repository Scope

If a repository's activity level or purpose changes significantly, a scope change can be proposed by any Maintainer through creating an issue in the community repository. The change must be approved following the decision-making process described in COMMUNITY_MEMBERSHIP.md.

All repository scope changes should be documented in:

  • The community meeting notes
  • The original proposal issue
  • Updated REPOSITORIES.md file