index.html 27 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057
  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. </ul>
  203. </nav>
  204. </li>
  205. <li class="md-nav__item md-nav__item--nested">
  206. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  207. <label class="md-nav__link" for="__nav_5">
  208. Provider
  209. <span class="md-nav__icon md-icon"></span>
  210. </label>
  211. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  212. <label class="md-nav__title" for="__nav_5">
  213. <span class="md-nav__icon md-icon"></span>
  214. Provider
  215. </label>
  216. <ul class="md-nav__list" data-md-scrollfix>
  217. <li class="md-nav__item md-nav__item--nested">
  218. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  219. <label class="md-nav__link" for="__nav_5_1">
  220. AWS
  221. <span class="md-nav__icon md-icon"></span>
  222. </label>
  223. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  224. <label class="md-nav__title" for="__nav_5_1">
  225. <span class="md-nav__icon md-icon"></span>
  226. AWS
  227. </label>
  228. <ul class="md-nav__list" data-md-scrollfix>
  229. <li class="md-nav__item">
  230. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  231. Secrets Manager
  232. </a>
  233. </li>
  234. <li class="md-nav__item">
  235. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  236. Parameter Store
  237. </a>
  238. </li>
  239. </ul>
  240. </nav>
  241. </li>
  242. <li class="md-nav__item md-nav__item--nested">
  243. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  244. <label class="md-nav__link" for="__nav_5_2">
  245. Azure
  246. <span class="md-nav__icon md-icon"></span>
  247. </label>
  248. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  249. <label class="md-nav__title" for="__nav_5_2">
  250. <span class="md-nav__icon md-icon"></span>
  251. Azure
  252. </label>
  253. <ul class="md-nav__list" data-md-scrollfix>
  254. <li class="md-nav__item">
  255. <a href="../provider-azure-key-vault/" class="md-nav__link">
  256. Key Vault
  257. </a>
  258. </li>
  259. </ul>
  260. </nav>
  261. </li>
  262. <li class="md-nav__item md-nav__item--nested">
  263. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  264. <label class="md-nav__link" for="__nav_5_3">
  265. Google
  266. <span class="md-nav__icon md-icon"></span>
  267. </label>
  268. <nav class="md-nav" aria-label="Google" data-md-level="2">
  269. <label class="md-nav__title" for="__nav_5_3">
  270. <span class="md-nav__icon md-icon"></span>
  271. Google
  272. </label>
  273. <ul class="md-nav__list" data-md-scrollfix>
  274. <li class="md-nav__item">
  275. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  276. Secrets Manager
  277. </a>
  278. </li>
  279. </ul>
  280. </nav>
  281. </li>
  282. <li class="md-nav__item md-nav__item--nested">
  283. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  284. <label class="md-nav__link" for="__nav_5_4">
  285. IBM
  286. <span class="md-nav__icon md-icon"></span>
  287. </label>
  288. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  289. <label class="md-nav__title" for="__nav_5_4">
  290. <span class="md-nav__icon md-icon"></span>
  291. IBM
  292. </label>
  293. <ul class="md-nav__list" data-md-scrollfix>
  294. <li class="md-nav__item">
  295. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  296. Secrets Manager
  297. </a>
  298. </li>
  299. </ul>
  300. </nav>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  304. HashiCorp Vault
  305. </a>
  306. </li>
  307. <li class="md-nav__item md-nav__item--nested">
  308. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_6" type="checkbox" id="__nav_5_6" >
  309. <label class="md-nav__link" for="__nav_5_6">
  310. Yandex
  311. <span class="md-nav__icon md-icon"></span>
  312. </label>
  313. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  314. <label class="md-nav__title" for="__nav_5_6">
  315. <span class="md-nav__icon md-icon"></span>
  316. Yandex
  317. </label>
  318. <ul class="md-nav__list" data-md-scrollfix>
  319. <li class="md-nav__item">
  320. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  321. Lockbox
  322. </a>
  323. </li>
  324. </ul>
  325. </nav>
  326. </li>
  327. <li class="md-nav__item md-nav__item--nested">
  328. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  329. <label class="md-nav__link" for="__nav_5_7">
  330. Gitlab
  331. <span class="md-nav__icon md-icon"></span>
  332. </label>
  333. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  334. <label class="md-nav__title" for="__nav_5_7">
  335. <span class="md-nav__icon md-icon"></span>
  336. Gitlab
  337. </label>
  338. <ul class="md-nav__list" data-md-scrollfix>
  339. <li class="md-nav__item">
  340. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  341. Gitlab Project Variables
  342. </a>
  343. </li>
  344. </ul>
  345. </nav>
  346. </li>
  347. </ul>
  348. </nav>
  349. </li>
  350. <li class="md-nav__item md-nav__item--nested">
  351. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  352. <label class="md-nav__link" for="__nav_6">
  353. References
  354. <span class="md-nav__icon md-icon"></span>
  355. </label>
  356. <nav class="md-nav" aria-label="References" data-md-level="1">
  357. <label class="md-nav__title" for="__nav_6">
  358. <span class="md-nav__icon md-icon"></span>
  359. References
  360. </label>
  361. <ul class="md-nav__list" data-md-scrollfix>
  362. <li class="md-nav__item">
  363. <a href="../spec/" class="md-nav__link">
  364. API specification
  365. </a>
  366. </li>
  367. </ul>
  368. </nav>
  369. </li>
  370. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  371. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" checked>
  372. <label class="md-nav__link" for="__nav_7">
  373. Contributing
  374. <span class="md-nav__icon md-icon"></span>
  375. </label>
  376. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  377. <label class="md-nav__title" for="__nav_7">
  378. <span class="md-nav__icon md-icon"></span>
  379. Contributing
  380. </label>
  381. <ul class="md-nav__list" data-md-scrollfix>
  382. <li class="md-nav__item">
  383. <a href="../contributing-devguide/" class="md-nav__link">
  384. Developer guide
  385. </a>
  386. </li>
  387. <li class="md-nav__item md-nav__item--active">
  388. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  389. <label class="md-nav__link md-nav__link--active" for="__toc">
  390. Contributing Process
  391. <span class="md-nav__icon md-icon"></span>
  392. </label>
  393. <a href="./" class="md-nav__link md-nav__link--active">
  394. Contributing Process
  395. </a>
  396. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  397. <label class="md-nav__title" for="__toc">
  398. <span class="md-nav__icon md-icon"></span>
  399. Table of contents
  400. </label>
  401. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  402. <li class="md-nav__item">
  403. <a href="#project-management" class="md-nav__link">
  404. Project Management
  405. </a>
  406. </li>
  407. <li class="md-nav__item">
  408. <a href="#issues" class="md-nav__link">
  409. Issues
  410. </a>
  411. </li>
  412. <li class="md-nav__item">
  413. <a href="#submitting-a-pull-request" class="md-nav__link">
  414. Submitting a Pull Request
  415. </a>
  416. </li>
  417. <li class="md-nav__item">
  418. <a href="#cutting-releases" class="md-nav__link">
  419. Cutting Releases
  420. </a>
  421. </li>
  422. </ul>
  423. </nav>
  424. </li>
  425. <li class="md-nav__item">
  426. <a href="../contributing-coc/" class="md-nav__link">
  427. Code of Conduct
  428. </a>
  429. </li>
  430. </ul>
  431. </nav>
  432. </li>
  433. <li class="md-nav__item">
  434. <a href="../deprecation-policy/" class="md-nav__link">
  435. Deprecation Policy
  436. </a>
  437. </li>
  438. </ul>
  439. </nav>
  440. </div>
  441. </div>
  442. </div>
  443. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  444. <div class="md-sidebar__scrollwrap">
  445. <div class="md-sidebar__inner">
  446. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  447. <label class="md-nav__title" for="__toc">
  448. <span class="md-nav__icon md-icon"></span>
  449. Table of contents
  450. </label>
  451. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  452. <li class="md-nav__item">
  453. <a href="#project-management" class="md-nav__link">
  454. Project Management
  455. </a>
  456. </li>
  457. <li class="md-nav__item">
  458. <a href="#issues" class="md-nav__link">
  459. Issues
  460. </a>
  461. </li>
  462. <li class="md-nav__item">
  463. <a href="#submitting-a-pull-request" class="md-nav__link">
  464. Submitting a Pull Request
  465. </a>
  466. </li>
  467. <li class="md-nav__item">
  468. <a href="#cutting-releases" class="md-nav__link">
  469. Cutting Releases
  470. </a>
  471. </li>
  472. </ul>
  473. </nav>
  474. </div>
  475. </div>
  476. </div>
  477. <div class="md-content" data-md-component="content">
  478. <article class="md-content__inner md-typeset">
  479. <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">
  480. <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>
  481. </a>
  482. <h1>Contributing Process</h1>
  483. <h2 id="project-management">Project Management</h2>
  484. <p>The Code, our TODOs and Documentation is maintained on
  485. <a href="https://github.com/external-secrets/external-secrets">GitHub</a>. All Issues
  486. should be opened in that repository.</p>
  487. <h2 id="issues">Issues</h2>
  488. <p>Features, bugs and any issues regarding the documentation should be filed as
  489. <a href="https://github.com/external-secrets/external-secrets/issues">GitHub Issue</a> in
  490. our repository. We use labels like <code>kind/feature</code>, <code>kind/bug</code>, <code>area/aws</code> to
  491. organize the issues. Issues labeled <code>good first issue</code> and <code>help wanted</code> are
  492. especially good for a first contribution. If you want to pick up an issue just
  493. leave a comment.</p>
  494. <h2 id="submitting-a-pull-request">Submitting a Pull Request</h2>
  495. <p>This project uses the well-known pull request process from GitHub. To submit a
  496. pull request, fork the repository and push any changes to a branch on the copy,
  497. from there a pull request can be made in the main repo. Merging a pull request
  498. requires the following steps to be completed before the pull request will
  499. be merged:</p>
  500. <ul>
  501. <li>ideally, there is an issue that documents the problem or feature in depth.</li>
  502. <li>code must have a reasonable amount of test coverage</li>
  503. <li>tests must pass</li>
  504. <li>PR needs be reviewed and approved</li>
  505. </ul>
  506. <p>Once these steps are completed the PR will be merged by a code owner.</p>
  507. <h2 id="cutting-releases">Cutting Releases</h2>
  508. <p>As of now this project is in an early alpha phase. There is just the main branch
  509. ;)</p>
  510. </article>
  511. </div>
  512. </div>
  513. </main>
  514. <footer class="md-footer">
  515. <nav class="md-footer__inner md-grid" aria-label="Footer">
  516. <a href="../contributing-devguide/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Developer guide" rel="prev">
  517. <div class="md-footer__button md-icon">
  518. <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>
  519. </div>
  520. <div class="md-footer__title">
  521. <div class="md-ellipsis">
  522. <span class="md-footer__direction">
  523. Previous
  524. </span>
  525. Developer guide
  526. </div>
  527. </div>
  528. </a>
  529. <a href="../contributing-coc/" class="md-footer__link md-footer__link--next" aria-label="Next: Code of Conduct" rel="next">
  530. <div class="md-footer__title">
  531. <div class="md-ellipsis">
  532. <span class="md-footer__direction">
  533. Next
  534. </span>
  535. Code of Conduct
  536. </div>
  537. </div>
  538. <div class="md-footer__button md-icon">
  539. <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>
  540. </div>
  541. </a>
  542. </nav>
  543. <div class="md-footer-meta md-typeset">
  544. <div class="md-footer-meta__inner md-grid">
  545. <div class="md-footer-copyright">
  546. Made with
  547. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  548. Material for MkDocs
  549. </a>
  550. </div>
  551. </div>
  552. </div>
  553. </footer>
  554. </div>
  555. <div class="md-dialog" data-md-component="dialog">
  556. <div class="md-dialog__inner md-typeset"></div>
  557. </div>
  558. <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>
  559. <script src="../assets/javascripts/bundle.76f349be.min.js"></script>
  560. </body>
  561. </html>