index.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858
  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. <meta http-equiv="x-ua-compatible" content="ie=edge">
  7. <meta name="lang:clipboard.copy" content="Copy to clipboard">
  8. <meta name="lang:clipboard.copied" content="Copied to clipboard">
  9. <meta name="lang:search.language" content="en">
  10. <meta name="lang:search.pipeline.stopwords" content="True">
  11. <meta name="lang:search.pipeline.trimmer" content="True">
  12. <meta name="lang:search.result.none" content="No matching documents">
  13. <meta name="lang:search.result.one" content="1 matching document">
  14. <meta name="lang:search.result.other" content="# matching documents">
  15. <meta name="lang:search.tokenizer" content="[\s\-]+">
  16. <link rel="shortcut icon" href="../assets/images/favicon.png">
  17. <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.6.0">
  18. <title>Contributing Process - External Secrets Operator</title>
  19. <link rel="stylesheet" href="../assets/stylesheets/application.1b62728e.css">
  20. <script src="../assets/javascripts/modernizr.268332fc.js"></script>
  21. <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
  22. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  23. <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
  24. <link rel="stylesheet" href="../assets/fonts/material-icons.css">
  25. </head>
  26. <body dir="ltr">
  27. <svg class="md-svg">
  28. <defs>
  29. <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>
  30. </defs>
  31. </svg>
  32. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  33. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  34. <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
  35. <a href="#project-management" tabindex="1" class="md-skip">
  36. Skip to content
  37. </a>
  38. <header class="md-header" data-md-component="header">
  39. <nav class="md-header-nav md-grid">
  40. <div class="md-flex">
  41. <div class="md-flex__cell md-flex__cell--shrink">
  42. <a href=".." title="External Secrets Operator" class="md-header-nav__button md-logo">
  43. <i class="md-icon"></i>
  44. </a>
  45. </div>
  46. <div class="md-flex__cell md-flex__cell--shrink">
  47. <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
  48. </div>
  49. <div class="md-flex__cell md-flex__cell--stretch">
  50. <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
  51. <span class="md-header-nav__topic">
  52. External Secrets Operator
  53. </span>
  54. <span class="md-header-nav__topic">
  55. Contributing Process
  56. </span>
  57. </div>
  58. </div>
  59. <div class="md-flex__cell md-flex__cell--shrink">
  60. <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
  61. <div class="md-search" data-md-component="search" role="dialog">
  62. <label class="md-search__overlay" for="__search"></label>
  63. <div class="md-search__inner" role="search">
  64. <form class="md-search__form" name="search">
  65. <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
  66. <label class="md-icon md-search__icon" for="__search"></label>
  67. <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
  68. &#xE5CD;
  69. </button>
  70. </form>
  71. <div class="md-search__output">
  72. <div class="md-search__scrollwrap" data-md-scrollfix>
  73. <div class="md-search-result" data-md-component="result">
  74. <div class="md-search-result__meta">
  75. Type to start searching
  76. </div>
  77. <ol class="md-search-result__list"></ol>
  78. </div>
  79. </div>
  80. </div>
  81. </div>
  82. </div>
  83. </div>
  84. <div class="md-flex__cell md-flex__cell--shrink">
  85. <div class="md-header-nav__source">
  86. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-source="github">
  87. <div class="md-source__icon">
  88. <svg viewBox="0 0 24 24" width="24" height="24">
  89. <use xlink:href="#__github" width="24" height="24"></use>
  90. </svg>
  91. </div>
  92. <div class="md-source__repository">
  93. External Secrets Operator
  94. </div>
  95. </a>
  96. </div>
  97. </div>
  98. </div>
  99. </nav>
  100. </header>
  101. <div class="md-container">
  102. <main class="md-main" role="main">
  103. <div class="md-main__inner md-grid" data-md-component="container">
  104. <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
  105. <div class="md-sidebar__scrollwrap">
  106. <div class="md-sidebar__inner">
  107. <nav class="md-nav md-nav--primary" data-md-level="0">
  108. <label class="md-nav__title md-nav__title--site" for="__drawer">
  109. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo">
  110. <i class="md-icon"></i>
  111. </a>
  112. External Secrets Operator
  113. </label>
  114. <div class="md-nav__source">
  115. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-source="github">
  116. <div class="md-source__icon">
  117. <svg viewBox="0 0 24 24" width="24" height="24">
  118. <use xlink:href="#__github" width="24" height="24"></use>
  119. </svg>
  120. </div>
  121. <div class="md-source__repository">
  122. External Secrets Operator
  123. </div>
  124. </a>
  125. </div>
  126. <ul class="md-nav__list" data-md-scrollfix>
  127. <li class="md-nav__item">
  128. <a href=".." title="Introduction" class="md-nav__link">
  129. Introduction
  130. </a>
  131. </li>
  132. <li class="md-nav__item">
  133. <a href="../api-overview/" title="Overview" class="md-nav__link">
  134. Overview
  135. </a>
  136. </li>
  137. <li class="md-nav__item md-nav__item--nested">
  138. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
  139. <label class="md-nav__link" for="nav-3">
  140. API Types
  141. </label>
  142. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  143. <label class="md-nav__title" for="nav-3">
  144. API Types
  145. </label>
  146. <ul class="md-nav__list" data-md-scrollfix>
  147. <li class="md-nav__item">
  148. <a href="../api-externalsecret/" title="ExternalSecret" class="md-nav__link">
  149. ExternalSecret
  150. </a>
  151. </li>
  152. <li class="md-nav__item">
  153. <a href="../api-secretstore/" title="SecretStore" class="md-nav__link">
  154. SecretStore
  155. </a>
  156. </li>
  157. <li class="md-nav__item">
  158. <a href="../api-clustersecretstore/" title="ClusterSecretStore" class="md-nav__link">
  159. ClusterSecretStore
  160. </a>
  161. </li>
  162. </ul>
  163. </nav>
  164. </li>
  165. <li class="md-nav__item md-nav__item--nested">
  166. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
  167. <label class="md-nav__link" for="nav-4">
  168. Guides
  169. </label>
  170. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  171. <label class="md-nav__title" for="nav-4">
  172. Guides
  173. </label>
  174. <ul class="md-nav__list" data-md-scrollfix>
  175. <li class="md-nav__item">
  176. <a href="../guides-introduction/" title="Introduction" class="md-nav__link">
  177. Introduction
  178. </a>
  179. </li>
  180. <li class="md-nav__item">
  181. <a href="../guides-getting-started/" title="Getting started" class="md-nav__link">
  182. Getting started
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../guides-templating/" title="Advanced Templating" class="md-nav__link">
  187. Advanced Templating
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../guides-multi-tenancy/" title="Multi Tenancy" class="md-nav__link">
  192. Multi Tenancy
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../guides-metrics/" title="Metrics" class="md-nav__link">
  197. Metrics
  198. </a>
  199. </li>
  200. </ul>
  201. </nav>
  202. </li>
  203. <li class="md-nav__item md-nav__item--nested">
  204. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
  205. <label class="md-nav__link" for="nav-5">
  206. Provider
  207. </label>
  208. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  209. <label class="md-nav__title" for="nav-5">
  210. Provider
  211. </label>
  212. <ul class="md-nav__list" data-md-scrollfix>
  213. <li class="md-nav__item md-nav__item--nested">
  214. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-1" type="checkbox" id="nav-5-1">
  215. <label class="md-nav__link" for="nav-5-1">
  216. AWS
  217. </label>
  218. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  219. <label class="md-nav__title" for="nav-5-1">
  220. AWS
  221. </label>
  222. <ul class="md-nav__list" data-md-scrollfix>
  223. <li class="md-nav__item">
  224. <a href="../provider-aws-secrets-manager/" title="Secrets Manager" class="md-nav__link">
  225. Secrets Manager
  226. </a>
  227. </li>
  228. <li class="md-nav__item">
  229. <a href="../provider-aws-parameter-store/" title="Parameter Store" class="md-nav__link">
  230. Parameter Store
  231. </a>
  232. </li>
  233. </ul>
  234. </nav>
  235. </li>
  236. <li class="md-nav__item md-nav__item--nested">
  237. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-2" type="checkbox" id="nav-5-2">
  238. <label class="md-nav__link" for="nav-5-2">
  239. Azure
  240. </label>
  241. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  242. <label class="md-nav__title" for="nav-5-2">
  243. Azure
  244. </label>
  245. <ul class="md-nav__list" data-md-scrollfix>
  246. <li class="md-nav__item">
  247. <a href="../provider-azure-key-vault/" title="Key Vault" class="md-nav__link">
  248. Key Vault
  249. </a>
  250. </li>
  251. </ul>
  252. </nav>
  253. </li>
  254. <li class="md-nav__item md-nav__item--nested">
  255. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-3" type="checkbox" id="nav-5-3">
  256. <label class="md-nav__link" for="nav-5-3">
  257. Google
  258. </label>
  259. <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
  260. <label class="md-nav__title" for="nav-5-3">
  261. Google
  262. </label>
  263. <ul class="md-nav__list" data-md-scrollfix>
  264. <li class="md-nav__item">
  265. <a href="../provider-google-secrets-manager/" title="Secrets Manager" class="md-nav__link">
  266. Secrets Manager
  267. </a>
  268. </li>
  269. </ul>
  270. </nav>
  271. </li>
  272. <li class="md-nav__item">
  273. <a href="../provider-hashicorp-vault/" title="HashiCorp Vault" class="md-nav__link">
  274. HashiCorp Vault
  275. </a>
  276. </li>
  277. </ul>
  278. </nav>
  279. </li>
  280. <li class="md-nav__item md-nav__item--nested">
  281. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
  282. <label class="md-nav__link" for="nav-6">
  283. References
  284. </label>
  285. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  286. <label class="md-nav__title" for="nav-6">
  287. References
  288. </label>
  289. <ul class="md-nav__list" data-md-scrollfix>
  290. <li class="md-nav__item">
  291. <a href="../spec/" title="API specification" class="md-nav__link">
  292. API specification
  293. </a>
  294. </li>
  295. </ul>
  296. </nav>
  297. </li>
  298. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  299. <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7" checked>
  300. <label class="md-nav__link" for="nav-7">
  301. Contributing
  302. </label>
  303. <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
  304. <label class="md-nav__title" for="nav-7">
  305. Contributing
  306. </label>
  307. <ul class="md-nav__list" data-md-scrollfix>
  308. <li class="md-nav__item">
  309. <a href="../contributing-devguide/" title="Developer guide" class="md-nav__link">
  310. Developer guide
  311. </a>
  312. </li>
  313. <li class="md-nav__item md-nav__item--active">
  314. <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  315. <label class="md-nav__link md-nav__link--active" for="__toc">
  316. Contributing Process
  317. </label>
  318. <a href="./" title="Contributing Process" class="md-nav__link md-nav__link--active">
  319. Contributing Process
  320. </a>
  321. <nav class="md-nav md-nav--secondary">
  322. <label class="md-nav__title" for="__toc">Table of contents</label>
  323. <ul class="md-nav__list" data-md-scrollfix>
  324. <li class="md-nav__item">
  325. <a href="#project-management" class="md-nav__link">
  326. Project Management
  327. </a>
  328. </li>
  329. <li class="md-nav__item">
  330. <a href="#issues" class="md-nav__link">
  331. Issues
  332. </a>
  333. </li>
  334. <li class="md-nav__item">
  335. <a href="#submitting-a-pull-request" class="md-nav__link">
  336. Submitting a Pull Request
  337. </a>
  338. </li>
  339. <li class="md-nav__item">
  340. <a href="#cutting-releases" class="md-nav__link">
  341. Cutting Releases
  342. </a>
  343. </li>
  344. </ul>
  345. </nav>
  346. </li>
  347. <li class="md-nav__item">
  348. <a href="../contributing-coc/" title="Code of Conduct" class="md-nav__link">
  349. Code of Conduct
  350. </a>
  351. </li>
  352. </ul>
  353. </nav>
  354. </li>
  355. </ul>
  356. </nav>
  357. </div>
  358. </div>
  359. </div>
  360. <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
  361. <div class="md-sidebar__scrollwrap">
  362. <div class="md-sidebar__inner">
  363. <nav class="md-nav md-nav--secondary">
  364. <label class="md-nav__title" for="__toc">Table of contents</label>
  365. <ul class="md-nav__list" data-md-scrollfix>
  366. <li class="md-nav__item">
  367. <a href="#project-management" class="md-nav__link">
  368. Project Management
  369. </a>
  370. </li>
  371. <li class="md-nav__item">
  372. <a href="#issues" class="md-nav__link">
  373. Issues
  374. </a>
  375. </li>
  376. <li class="md-nav__item">
  377. <a href="#submitting-a-pull-request" class="md-nav__link">
  378. Submitting a Pull Request
  379. </a>
  380. </li>
  381. <li class="md-nav__item">
  382. <a href="#cutting-releases" class="md-nav__link">
  383. Cutting Releases
  384. </a>
  385. </li>
  386. </ul>
  387. </nav>
  388. </div>
  389. </div>
  390. </div>
  391. <div class="md-content">
  392. <article class="md-content__inner md-typeset">
  393. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/contributing-process.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
  394. <h1>Contributing Process</h1>
  395. <h2 id="project-management">Project Management</h2>
  396. <p>The Code, our TODOs and Documentation is maintained on
  397. <a href="https://github.com/external-secrets/external-secrets">GitHub</a>. All Issues
  398. should be opened in that repository.</p>
  399. <h2 id="issues">Issues</h2>
  400. <p>Features, bugs and any issues regarding the documentation should be filed as
  401. <a href="https://github.com/external-secrets/external-secrets/issues">GitHub Issue</a> in
  402. our repository. We use labels like <code>kind/feature</code>, <code>kind/bug</code>, <code>area/aws</code> to
  403. organize the issues. Issues labeled <code>good first issue</code> and <code>help wanted</code> are
  404. especially good for a first contribution. If you want to pick up an issue just
  405. leave a comment.</p>
  406. <h2 id="submitting-a-pull-request">Submitting a Pull Request</h2>
  407. <p>This project uses the well-known pull request process from GitHub. To submit a
  408. pull request, fork the repository and push any changes to a branch on the copy,
  409. from there a pull request can be made in the main repo. Merging a pull request
  410. requires the following steps to be completed before the pull request will
  411. be merged:</p>
  412. <ul>
  413. <li>ideally, there is an issue that documents the problem or feature in depth.</li>
  414. <li>code must have a reasonable amount of test coverage</li>
  415. <li>tests must pass</li>
  416. <li>PR needs be reviewed and approved</li>
  417. </ul>
  418. <p>Once these steps are completed the PR will be merged by a code owner.</p>
  419. <h2 id="cutting-releases">Cutting Releases</h2>
  420. <p>As of now this project is in an early alpha phase. There is just the main branch
  421. ;)</p>
  422. </article>
  423. </div>
  424. </div>
  425. </main>
  426. <footer class="md-footer">
  427. <div class="md-footer-nav">
  428. <nav class="md-footer-nav__inner md-grid">
  429. <a href="../contributing-devguide/" title="Developer guide" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
  430. <div class="md-flex__cell md-flex__cell--shrink">
  431. <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
  432. </div>
  433. <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
  434. <span class="md-flex__ellipsis">
  435. <span class="md-footer-nav__direction">
  436. Previous
  437. </span>
  438. Developer guide
  439. </span>
  440. </div>
  441. </a>
  442. <a href="../contributing-coc/" title="Code of Conduct" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
  443. <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
  444. <span class="md-flex__ellipsis">
  445. <span class="md-footer-nav__direction">
  446. Next
  447. </span>
  448. Code of Conduct
  449. </span>
  450. </div>
  451. <div class="md-flex__cell md-flex__cell--shrink">
  452. <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
  453. </div>
  454. </a>
  455. </nav>
  456. </div>
  457. <div class="md-footer-meta md-typeset">
  458. <div class="md-footer-meta__inner md-grid">
  459. <div class="md-footer-copyright">
  460. powered by
  461. <a href="https://www.mkdocs.org">MkDocs</a>
  462. and
  463. <a href="https://squidfunk.github.io/mkdocs-material/">
  464. Material for MkDocs</a>
  465. </div>
  466. </div>
  467. </div>
  468. </footer>
  469. </div>
  470. <script src="../assets/javascripts/application.808e90bb.js"></script>
  471. <script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
  472. </body>
  473. </html>