index.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="icon" href="../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.1, mkdocs-material-7.1.8">
  8. <title>Contributing Process - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.ca7ac06f.min.css">
  10. <link rel="stylesheet" href="../assets/stylesheets/palette.f1a3b89f.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
  14. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){"undefined"!=typeof location$&&location$.subscribe(function(t){gtag("config","G-QP38TD8K7V",{page_path:t.pathname})})})</script>
  15. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  16. </head>
  17. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  18. <script>function __prefix(e){return new URL("..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. <a href="#project-management" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <header class="md-header" data-md-component="header">
  30. <nav class="md-header__inner md-grid" aria-label="Header">
  31. <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  32. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  33. </a>
  34. <label class="md-header__button md-icon" for="__drawer">
  35. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  36. </label>
  37. <div class="md-header__title" data-md-component="header-title">
  38. <div class="md-header__ellipsis">
  39. <div class="md-header__topic">
  40. <span class="md-ellipsis">
  41. External Secrets Operator
  42. </span>
  43. </div>
  44. <div class="md-header__topic" data-md-component="header-topic">
  45. <span class="md-ellipsis">
  46. Contributing Process
  47. </span>
  48. </div>
  49. </div>
  50. </div>
  51. <label class="md-header__button md-icon" for="__search">
  52. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  53. </label>
  54. <div class="md-search" data-md-component="search" role="dialog">
  55. <label class="md-search__overlay" for="__search"></label>
  56. <div class="md-search__inner" role="search">
  57. <form class="md-search__form" name="search">
  58. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
  59. <label class="md-search__icon md-icon" for="__search">
  60. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  61. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  62. </label>
  63. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  64. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  65. </button>
  66. </form>
  67. <div class="md-search__output">
  68. <div class="md-search__scrollwrap" data-md-scrollfix>
  69. <div class="md-search-result" data-md-component="search-result">
  70. <div class="md-search-result__meta">
  71. Initializing search
  72. </div>
  73. <ol class="md-search-result__list"></ol>
  74. </div>
  75. </div>
  76. </div>
  77. </div>
  78. </div>
  79. <div class="md-header__source">
  80. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  81. <div class="md-source__icon md-icon">
  82. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  83. </div>
  84. <div class="md-source__repository">
  85. External Secrets Operator
  86. </div>
  87. </a>
  88. </div>
  89. </nav>
  90. </header>
  91. <div class="md-container" data-md-component="container">
  92. <main class="md-main" data-md-component="main">
  93. <div class="md-main__inner md-grid">
  94. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  95. <div class="md-sidebar__scrollwrap">
  96. <div class="md-sidebar__inner">
  97. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  98. <label class="md-nav__title" for="__drawer">
  99. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  100. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  101. </a>
  102. External Secrets Operator
  103. </label>
  104. <div class="md-nav__source">
  105. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  106. <div class="md-source__icon md-icon">
  107. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  108. </div>
  109. <div class="md-source__repository">
  110. External Secrets Operator
  111. </div>
  112. </a>
  113. </div>
  114. <ul class="md-nav__list" data-md-scrollfix>
  115. <li class="md-nav__item">
  116. <a href=".." class="md-nav__link">
  117. Introduction
  118. </a>
  119. </li>
  120. <li class="md-nav__item">
  121. <a href="../api-overview/" class="md-nav__link">
  122. Overview
  123. </a>
  124. </li>
  125. <li class="md-nav__item md-nav__item--nested">
  126. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  127. <label class="md-nav__link" for="__nav_3">
  128. API Types
  129. <span class="md-nav__icon md-icon"></span>
  130. </label>
  131. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  132. <label class="md-nav__title" for="__nav_3">
  133. <span class="md-nav__icon md-icon"></span>
  134. API Types
  135. </label>
  136. <ul class="md-nav__list" data-md-scrollfix>
  137. <li class="md-nav__item">
  138. <a href="../api-externalsecret/" class="md-nav__link">
  139. ExternalSecret
  140. </a>
  141. </li>
  142. <li class="md-nav__item">
  143. <a href="../api-secretstore/" class="md-nav__link">
  144. SecretStore
  145. </a>
  146. </li>
  147. <li class="md-nav__item">
  148. <a href="../api-clustersecretstore/" class="md-nav__link">
  149. ClusterSecretStore
  150. </a>
  151. </li>
  152. </ul>
  153. </nav>
  154. </li>
  155. <li class="md-nav__item md-nav__item--nested">
  156. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  157. <label class="md-nav__link" for="__nav_4">
  158. Guides
  159. <span class="md-nav__icon md-icon"></span>
  160. </label>
  161. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  162. <label class="md-nav__title" for="__nav_4">
  163. <span class="md-nav__icon md-icon"></span>
  164. Guides
  165. </label>
  166. <ul class="md-nav__list" data-md-scrollfix>
  167. <li class="md-nav__item">
  168. <a href="../guides-introduction/" class="md-nav__link">
  169. Introduction
  170. </a>
  171. </li>
  172. <li class="md-nav__item">
  173. <a href="../guides-getting-started/" class="md-nav__link">
  174. Getting started
  175. </a>
  176. </li>
  177. <li class="md-nav__item">
  178. <a href="../guides-templating/" class="md-nav__link">
  179. Advanced Templating
  180. </a>
  181. </li>
  182. <li class="md-nav__item">
  183. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  184. All keys, One secret
  185. </a>
  186. </li>
  187. <li class="md-nav__item">
  188. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  189. Common K8S Secret Types
  190. </a>
  191. </li>
  192. <li class="md-nav__item">
  193. <a href="../guides-multi-tenancy/" class="md-nav__link">
  194. Multi Tenancy
  195. </a>
  196. </li>
  197. <li class="md-nav__item">
  198. <a href="../guides-metrics/" class="md-nav__link">
  199. Metrics
  200. </a>
  201. </li>
  202. <li class="md-nav__item">
  203. <a href="../guides-using-latest-image/" class="md-nav__link">
  204. Using Latest Image
  205. </a>
  206. </li>
  207. <li class="md-nav__item">
  208. <a href="../guides-gitops-using-fluxcd/" class="md-nav__link">
  209. GitOps using FluxCD
  210. </a>
  211. </li>
  212. </ul>
  213. </nav>
  214. </li>
  215. <li class="md-nav__item md-nav__item--nested">
  216. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  217. <label class="md-nav__link" for="__nav_5">
  218. Provider
  219. <span class="md-nav__icon md-icon"></span>
  220. </label>
  221. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  222. <label class="md-nav__title" for="__nav_5">
  223. <span class="md-nav__icon md-icon"></span>
  224. Provider
  225. </label>
  226. <ul class="md-nav__list" data-md-scrollfix>
  227. <li class="md-nav__item md-nav__item--nested">
  228. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  229. <label class="md-nav__link" for="__nav_5_1">
  230. AWS
  231. <span class="md-nav__icon md-icon"></span>
  232. </label>
  233. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  234. <label class="md-nav__title" for="__nav_5_1">
  235. <span class="md-nav__icon md-icon"></span>
  236. AWS
  237. </label>
  238. <ul class="md-nav__list" data-md-scrollfix>
  239. <li class="md-nav__item">
  240. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  241. Secrets Manager
  242. </a>
  243. </li>
  244. <li class="md-nav__item">
  245. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  246. Parameter Store
  247. </a>
  248. </li>
  249. </ul>
  250. </nav>
  251. </li>
  252. <li class="md-nav__item md-nav__item--nested">
  253. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  254. <label class="md-nav__link" for="__nav_5_2">
  255. Azure
  256. <span class="md-nav__icon md-icon"></span>
  257. </label>
  258. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  259. <label class="md-nav__title" for="__nav_5_2">
  260. <span class="md-nav__icon md-icon"></span>
  261. Azure
  262. </label>
  263. <ul class="md-nav__list" data-md-scrollfix>
  264. <li class="md-nav__item">
  265. <a href="../provider-azure-key-vault/" class="md-nav__link">
  266. Key Vault
  267. </a>
  268. </li>
  269. </ul>
  270. </nav>
  271. </li>
  272. <li class="md-nav__item md-nav__item--nested">
  273. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  274. <label class="md-nav__link" for="__nav_5_3">
  275. Google
  276. <span class="md-nav__icon md-icon"></span>
  277. </label>
  278. <nav class="md-nav" aria-label="Google" data-md-level="2">
  279. <label class="md-nav__title" for="__nav_5_3">
  280. <span class="md-nav__icon md-icon"></span>
  281. Google
  282. </label>
  283. <ul class="md-nav__list" data-md-scrollfix>
  284. <li class="md-nav__item">
  285. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  286. Secrets Manager
  287. </a>
  288. </li>
  289. </ul>
  290. </nav>
  291. </li>
  292. <li class="md-nav__item md-nav__item--nested">
  293. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  294. <label class="md-nav__link" for="__nav_5_4">
  295. IBM
  296. <span class="md-nav__icon md-icon"></span>
  297. </label>
  298. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  299. <label class="md-nav__title" for="__nav_5_4">
  300. <span class="md-nav__icon md-icon"></span>
  301. IBM
  302. </label>
  303. <ul class="md-nav__list" data-md-scrollfix>
  304. <li class="md-nav__item">
  305. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  306. Secrets Manager
  307. </a>
  308. </li>
  309. </ul>
  310. </nav>
  311. </li>
  312. <li class="md-nav__item">
  313. <a href="../provider-akeyless/" class="md-nav__link">
  314. Akeyless
  315. </a>
  316. </li>
  317. <li class="md-nav__item">
  318. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  319. HashiCorp Vault
  320. </a>
  321. </li>
  322. <li class="md-nav__item md-nav__item--nested">
  323. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  324. <label class="md-nav__link" for="__nav_5_7">
  325. Yandex
  326. <span class="md-nav__icon md-icon"></span>
  327. </label>
  328. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  329. <label class="md-nav__title" for="__nav_5_7">
  330. <span class="md-nav__icon md-icon"></span>
  331. Yandex
  332. </label>
  333. <ul class="md-nav__list" data-md-scrollfix>
  334. <li class="md-nav__item">
  335. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  336. Lockbox
  337. </a>
  338. </li>
  339. </ul>
  340. </nav>
  341. </li>
  342. <li class="md-nav__item md-nav__item--nested">
  343. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  344. <label class="md-nav__link" for="__nav_5_8">
  345. Gitlab
  346. <span class="md-nav__icon md-icon"></span>
  347. </label>
  348. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  349. <label class="md-nav__title" for="__nav_5_8">
  350. <span class="md-nav__icon md-icon"></span>
  351. Gitlab
  352. </label>
  353. <ul class="md-nav__list" data-md-scrollfix>
  354. <li class="md-nav__item">
  355. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  356. Gitlab Project Variables
  357. </a>
  358. </li>
  359. </ul>
  360. </nav>
  361. </li>
  362. <li class="md-nav__item md-nav__item--nested">
  363. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  364. <label class="md-nav__link" for="__nav_5_9">
  365. Oracle
  366. <span class="md-nav__icon md-icon"></span>
  367. </label>
  368. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  369. <label class="md-nav__title" for="__nav_5_9">
  370. <span class="md-nav__icon md-icon"></span>
  371. Oracle
  372. </label>
  373. <ul class="md-nav__list" data-md-scrollfix>
  374. <li class="md-nav__item">
  375. <a href="../provider-oracle-vault/" class="md-nav__link">
  376. Oracle Vault
  377. </a>
  378. </li>
  379. </ul>
  380. </nav>
  381. </li>
  382. <li class="md-nav__item">
  383. <a href="../provider-webhook/" class="md-nav__link">
  384. Webhook
  385. </a>
  386. </li>
  387. </ul>
  388. </nav>
  389. </li>
  390. <li class="md-nav__item md-nav__item--nested">
  391. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  392. <label class="md-nav__link" for="__nav_6">
  393. References
  394. <span class="md-nav__icon md-icon"></span>
  395. </label>
  396. <nav class="md-nav" aria-label="References" data-md-level="1">
  397. <label class="md-nav__title" for="__nav_6">
  398. <span class="md-nav__icon md-icon"></span>
  399. References
  400. </label>
  401. <ul class="md-nav__list" data-md-scrollfix>
  402. <li class="md-nav__item">
  403. <a href="../spec/" class="md-nav__link">
  404. API specification
  405. </a>
  406. </li>
  407. </ul>
  408. </nav>
  409. </li>
  410. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  411. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" checked>
  412. <label class="md-nav__link" for="__nav_7">
  413. Contributing
  414. <span class="md-nav__icon md-icon"></span>
  415. </label>
  416. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  417. <label class="md-nav__title" for="__nav_7">
  418. <span class="md-nav__icon md-icon"></span>
  419. Contributing
  420. </label>
  421. <ul class="md-nav__list" data-md-scrollfix>
  422. <li class="md-nav__item">
  423. <a href="../contributing-devguide/" class="md-nav__link">
  424. Developer guide
  425. </a>
  426. </li>
  427. <li class="md-nav__item md-nav__item--active">
  428. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  429. <label class="md-nav__link md-nav__link--active" for="__toc">
  430. Contributing Process
  431. <span class="md-nav__icon md-icon"></span>
  432. </label>
  433. <a href="./" class="md-nav__link md-nav__link--active">
  434. Contributing Process
  435. </a>
  436. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  437. <label class="md-nav__title" for="__toc">
  438. <span class="md-nav__icon md-icon"></span>
  439. Table of contents
  440. </label>
  441. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  442. <li class="md-nav__item">
  443. <a href="#project-management" class="md-nav__link">
  444. Project Management
  445. </a>
  446. </li>
  447. <li class="md-nav__item">
  448. <a href="#issues" class="md-nav__link">
  449. Issues
  450. </a>
  451. </li>
  452. <li class="md-nav__item">
  453. <a href="#submitting-a-pull-request" class="md-nav__link">
  454. Submitting a Pull Request
  455. </a>
  456. </li>
  457. <li class="md-nav__item">
  458. <a href="#proposal-process" class="md-nav__link">
  459. Proposal Process
  460. </a>
  461. </li>
  462. <li class="md-nav__item">
  463. <a href="#cutting-releases" class="md-nav__link">
  464. Cutting Releases
  465. </a>
  466. </li>
  467. </ul>
  468. </nav>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="../contributing-coc/" class="md-nav__link">
  472. Code of Conduct
  473. </a>
  474. </li>
  475. </ul>
  476. </nav>
  477. </li>
  478. <li class="md-nav__item">
  479. <a href="../deprecation-policy/" class="md-nav__link">
  480. Deprecation Policy
  481. </a>
  482. </li>
  483. </ul>
  484. </nav>
  485. </div>
  486. </div>
  487. </div>
  488. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  489. <div class="md-sidebar__scrollwrap">
  490. <div class="md-sidebar__inner">
  491. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  492. <label class="md-nav__title" for="__toc">
  493. <span class="md-nav__icon md-icon"></span>
  494. Table of contents
  495. </label>
  496. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  497. <li class="md-nav__item">
  498. <a href="#project-management" class="md-nav__link">
  499. Project Management
  500. </a>
  501. </li>
  502. <li class="md-nav__item">
  503. <a href="#issues" class="md-nav__link">
  504. Issues
  505. </a>
  506. </li>
  507. <li class="md-nav__item">
  508. <a href="#submitting-a-pull-request" class="md-nav__link">
  509. Submitting a Pull Request
  510. </a>
  511. </li>
  512. <li class="md-nav__item">
  513. <a href="#proposal-process" class="md-nav__link">
  514. Proposal Process
  515. </a>
  516. </li>
  517. <li class="md-nav__item">
  518. <a href="#cutting-releases" class="md-nav__link">
  519. Cutting Releases
  520. </a>
  521. </li>
  522. </ul>
  523. </nav>
  524. </div>
  525. </div>
  526. </div>
  527. <div class="md-content" data-md-component="content">
  528. <article class="md-content__inner md-typeset">
  529. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/contributing-process.md" title="Edit this page" class="md-content__button md-icon">
  530. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
  531. </a>
  532. <h1>Contributing Process</h1>
  533. <h2 id="project-management">Project Management</h2>
  534. <p>The Code, our TODOs and Documentation is maintained on
  535. <a href="https://github.com/external-secrets/external-secrets">GitHub</a>. All Issues
  536. should be opened in that repository.</p>
  537. <h2 id="issues">Issues</h2>
  538. <p>Features, bugs and any issues regarding the documentation should be filed as
  539. <a href="https://github.com/external-secrets/external-secrets/issues">GitHub Issue</a> in
  540. our repository. We use labels like <code>kind/feature</code>, <code>kind/bug</code>, <code>area/aws</code> to
  541. organize the issues. Issues labeled <code>good first issue</code> and <code>help wanted</code> are
  542. especially good for a first contribution. If you want to pick up an issue just
  543. leave a comment.</p>
  544. <h2 id="submitting-a-pull-request">Submitting a Pull Request</h2>
  545. <p>This project uses the well-known pull request process from GitHub. To submit a
  546. pull request, fork the repository and push any changes to a branch on the copy,
  547. from there a pull request can be made in the main repo. Merging a pull request
  548. requires the following steps to be completed before the pull request will
  549. be merged:</p>
  550. <ul>
  551. <li>ideally, there is an issue that documents the problem or feature in depth.</li>
  552. <li>code must have a reasonable amount of test coverage</li>
  553. <li>tests must pass</li>
  554. <li>PR needs be reviewed and approved</li>
  555. </ul>
  556. <p>Once these steps are completed the PR will be merged by a code owner.
  557. We're using the pull request <code>assignee</code> feature to track who is responsible
  558. for the lifecycle of the PR: review, merging, ping on inactivity, close.
  559. We close pull requests or issues if there is no response from the author for
  560. a period of time. Feel free to reopen if you want to get back on it.</p>
  561. <h2 id="proposal-process">Proposal Process</h2>
  562. <p>Before we introduce significant changes to the project we want to gather feedback
  563. from the community to ensure that we progress in the right direction before we
  564. develop and release big changes. Significant changes include for example:
  565. * creating new custom resources
  566. * proposing breaking changes
  567. * changing the behavior of the controller significantly</p>
  568. <p>Please create a document in the <code>design/</code> directory based on the template <code>000-template.md</code>
  569. and fill in your proposal. Open a pull request in draft mode and request feedback. Once the proposal is accepted and the pull request is merged we can create work packages and proceed with the implementation.</p>
  570. <h2 id="cutting-releases">Cutting Releases</h2>
  571. <p>The external-secrets project is released on a as-needed basis. Feel free to open a issue to request a release. Details on how to cut a release can be found in the <code>RELEASE.md</code> file in the repo.</p>
  572. </article>
  573. </div>
  574. </div>
  575. </main>
  576. <footer class="md-footer">
  577. <nav class="md-footer__inner md-grid" aria-label="Footer">
  578. <a href="../contributing-devguide/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Developer guide" rel="prev">
  579. <div class="md-footer__button md-icon">
  580. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  581. </div>
  582. <div class="md-footer__title">
  583. <div class="md-ellipsis">
  584. <span class="md-footer__direction">
  585. Previous
  586. </span>
  587. Developer guide
  588. </div>
  589. </div>
  590. </a>
  591. <a href="../contributing-coc/" class="md-footer__link md-footer__link--next" aria-label="Next: Code of Conduct" rel="next">
  592. <div class="md-footer__title">
  593. <div class="md-ellipsis">
  594. <span class="md-footer__direction">
  595. Next
  596. </span>
  597. Code of Conduct
  598. </div>
  599. </div>
  600. <div class="md-footer__button md-icon">
  601. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  602. </div>
  603. </a>
  604. </nav>
  605. <div class="md-footer-meta md-typeset">
  606. <div class="md-footer-meta__inner md-grid">
  607. <div class="md-footer-copyright">
  608. Made with
  609. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  610. Material for MkDocs
  611. </a>
  612. </div>
  613. </div>
  614. </div>
  615. </footer>
  616. </div>
  617. <div class="md-dialog" data-md-component="dialog">
  618. <div class="md-dialog__inner md-typeset"></div>
  619. </div>
  620. <script id="__config" type="application/json">{"base": "..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../assets/javascripts/workers/search.b0710199.min.js", "version": null}</script>
  621. <script src="../assets/javascripts/bundle.76f349be.min.js"></script>
  622. </body>
  623. </html>