mirror of
https://github.com/empayre/fleet.git
synced 2024-11-06 17:05:18 +00:00
b5b7fba561
Everyone can contribute to the handbook, and page DRIs are expected to keep their pages up to date. To shape and absorb changes, and learn from how GitLab evolved its handbook as that company grew, CEO will ALSO review all PRs that change the handbook before they are merged. (Background: As of mid-2023, there are only ≤3 handbook PRs per weekday on the busiest of weeks. If this increases dramatically, or when time allows the company to prioritize writing down the content design, structure, and vision for the evolution of the handbook, we'll change ) --------- Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
97 lines
6.8 KiB
Plaintext
97 lines
6.8 KiB
Plaintext
##############################################################################################
|
||
# ██████╗ ██████╗ ██████╗ ███████╗ ██████╗ ██╗ ██╗███╗ ██╗███████╗██████╗ ███████╗
|
||
# ██╔════╝██╔═══██╗██╔══██╗██╔════╝██╔═══██╗██║ ██║████╗ ██║██╔════╝██╔══██╗██╔════╝
|
||
# ██║ ██║ ██║██║ ██║█████╗ ██║ ██║██║ █╗ ██║██╔██╗ ██║█████╗ ██████╔╝███████╗
|
||
# ██║ ██║ ██║██║ ██║██╔══╝ ██║ ██║██║███╗██║██║╚██╗██║██╔══╝ ██╔══██╗╚════██║
|
||
# ╚██████╗╚██████╔╝██████╔╝███████╗╚██████╔╝╚███╔███╔╝██║ ╚████║███████╗██║ ██║███████║
|
||
# ╚═════╝ ╚═════╝ ╚═════╝ ╚══════╝ ╚═════╝ ╚══╝╚══╝ ╚═╝ ╚═══╝╚══════╝╚═╝ ╚═╝╚══════╝
|
||
##############################################################################################
|
||
# ⛔ This file indicates REQUIRED reviewers for changes to certain file paths in this repo.
|
||
#
|
||
# > How? This "requiredness" is provided natively by GitHub. If a team is specified, then
|
||
# > the logic behaves slightly differently. See GitHub's latest documentation on CODEOWNERS
|
||
# > for more information. CODEOWNERS is especially useful for paths that usually end up
|
||
# > in PRs with lots of other reviewers.)
|
||
#
|
||
# ⚠️ For file paths not listed, the DRI is instead indicated in website/config/custom.js.
|
||
# Regardless of whether a path's DRI is configured in CODEOWNERS or custom.js, the DRI is
|
||
# automatically requested for review when changes are proposed.
|
||
# [!] But beware: No path should ever be configured as a DRI in both CODEOWNERS _and_
|
||
# the website config.
|
||
# [!] In addition, no path should ever be configured in CODEOWNERS if there is ALSO one
|
||
# of its ancestral paths configured in website/config/custom.js.
|
||
#
|
||
# ✅ Some paths also have multiple individuals who are allowed to make changes without review,
|
||
# even though they are not the DRI. These are called "maintainers".
|
||
#
|
||
# For more information on how this works, see:
|
||
# - What is a DRI and how is this configured? https://fleetdm.com/handbook/company/why-this-way#why-direct-responsibility
|
||
# - Historical context: https://github.com/fleetdm/fleet/pull/12786
|
||
##############################################################################################
|
||
|
||
|
||
##############################################################################################
|
||
# 🚀 Golang files and other files related to the core product backend.
|
||
# (1 or more Golang-literate engineers is required to review changes.)
|
||
# FUTURE: Look for a way to not have this notify every single person in this "github team".
|
||
##############################################################################################
|
||
*.go @fleetdm/go
|
||
go.sum @fleetdm/go
|
||
go.mod @fleetdm/go
|
||
/server/ @fleetdm/go
|
||
/cmd/ @fleetdm/go
|
||
|
||
##############################################################################################
|
||
# 🚀 React files and other files related to the core product frontend.
|
||
# (1 or more React-literate engineers is required to review changes.)
|
||
# FUTURE: Look for a way to not have this notify every single person in this "github team".
|
||
##############################################################################################
|
||
/frontend/ @fleetdm/frontend
|
||
|
||
##############################################################################################
|
||
# 🚀 Config as code for infrastructure, internal security and IT use cases, and more.
|
||
# (1 or more infra-literate engineers is required to review changes.)
|
||
# FUTURE: Look for a way to not have this notify every single person in this "github team".
|
||
##############################################################################################
|
||
/infrastructure/ @fleetdm/infra @edwardsb
|
||
/charts/ @fleetdm/infra @edwardsb
|
||
/terraform/ @fleetdm/infra @edwardsb
|
||
|
||
##############################################################################################
|
||
# ⚗️ Reference, config surface, built-in queries, API, and other documentation.
|
||
#
|
||
# (see website/config/custom.js for DRIs of other paths not listed here)
|
||
##############################################################################################
|
||
/docs @rachaelshaw
|
||
/docs/Using-Fleet/REST-API.md @rachaelshaw # « REST API reference documentation
|
||
/docs/Contributing/API-for-contributors.md @rachaelshaw # « Advanced / contributors-only API reference documentation
|
||
/schema @rachaelshaw # « Data tables (osquery/fleetd schema) documentation
|
||
|
||
##############################################################################################
|
||
# 🫧 Pricing and features
|
||
#
|
||
# (see website/config/custom.js for DRIs of other paths not listed here)
|
||
##############################################################################################
|
||
/website/views/pages/pricing.ejs @mikermcneil # « CEO is DRI for pricing
|
||
/handbook/company/pricing-features-table.yml @mikermcneil # « CEO is current DRI for features table
|
||
|
||
##############################################################################################
|
||
# 🦿 Repo automation and change control settings
|
||
##############################################################################################
|
||
/CODEOWNERS @mikermcneil # See https://github.com/fleetdm/fleet/pull/13195
|
||
|
||
##############################################################################################
|
||
# 🦿 Handbook
|
||
#
|
||
# (see website/config/custom.js for DRIs of other paths not listed here)
|
||
##############################################################################################
|
||
/handbook @mikermcneil # See https://github.com/fleetdm/fleet/pull/13195
|
||
|
||
##############################################################################################
|
||
# 🦿 GitHub issue templates
|
||
##############################################################################################
|
||
/.github/ISSUE_TEMPLATE @mikermcneil # See https://github.com/fleetdm/fleet/pull/13195
|
||
|
||
# ℹ️ But wait, there's more!
|
||
# See the comments up top to learn where else DRIs and maintainers are configured.
|