index.html 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901
  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-multi-tenancy/" class="md-nav__link">
  184. Multi Tenancy
  185. </a>
  186. </li>
  187. <li class="md-nav__item">
  188. <a href="../guides-metrics/" class="md-nav__link">
  189. Metrics
  190. </a>
  191. </li>
  192. </ul>
  193. </nav>
  194. </li>
  195. <li class="md-nav__item md-nav__item--nested">
  196. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  197. <label class="md-nav__link" for="__nav_5">
  198. Provider
  199. <span class="md-nav__icon md-icon"></span>
  200. </label>
  201. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  202. <label class="md-nav__title" for="__nav_5">
  203. <span class="md-nav__icon md-icon"></span>
  204. Provider
  205. </label>
  206. <ul class="md-nav__list" data-md-scrollfix>
  207. <li class="md-nav__item md-nav__item--nested">
  208. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  209. <label class="md-nav__link" for="__nav_5_1">
  210. AWS
  211. <span class="md-nav__icon md-icon"></span>
  212. </label>
  213. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  214. <label class="md-nav__title" for="__nav_5_1">
  215. <span class="md-nav__icon md-icon"></span>
  216. AWS
  217. </label>
  218. <ul class="md-nav__list" data-md-scrollfix>
  219. <li class="md-nav__item">
  220. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  221. Secrets Manager
  222. </a>
  223. </li>
  224. <li class="md-nav__item">
  225. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  226. Parameter Store
  227. </a>
  228. </li>
  229. </ul>
  230. </nav>
  231. </li>
  232. <li class="md-nav__item md-nav__item--nested">
  233. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  234. <label class="md-nav__link" for="__nav_5_2">
  235. Azure
  236. <span class="md-nav__icon md-icon"></span>
  237. </label>
  238. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  239. <label class="md-nav__title" for="__nav_5_2">
  240. <span class="md-nav__icon md-icon"></span>
  241. Azure
  242. </label>
  243. <ul class="md-nav__list" data-md-scrollfix>
  244. <li class="md-nav__item">
  245. <a href="../provider-azure-key-vault/" class="md-nav__link">
  246. Key Vault
  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_3" type="checkbox" id="__nav_5_3" >
  254. <label class="md-nav__link" for="__nav_5_3">
  255. Google
  256. <span class="md-nav__icon md-icon"></span>
  257. </label>
  258. <nav class="md-nav" aria-label="Google" data-md-level="2">
  259. <label class="md-nav__title" for="__nav_5_3">
  260. <span class="md-nav__icon md-icon"></span>
  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/" 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/" 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-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  282. <label class="md-nav__link" for="__nav_6">
  283. References
  284. <span class="md-nav__icon md-icon"></span>
  285. </label>
  286. <nav class="md-nav" aria-label="References" data-md-level="1">
  287. <label class="md-nav__title" for="__nav_6">
  288. <span class="md-nav__icon md-icon"></span>
  289. References
  290. </label>
  291. <ul class="md-nav__list" data-md-scrollfix>
  292. <li class="md-nav__item">
  293. <a href="../spec/" class="md-nav__link">
  294. API specification
  295. </a>
  296. </li>
  297. </ul>
  298. </nav>
  299. </li>
  300. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  301. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" checked>
  302. <label class="md-nav__link" for="__nav_7">
  303. Contributing
  304. <span class="md-nav__icon md-icon"></span>
  305. </label>
  306. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  307. <label class="md-nav__title" for="__nav_7">
  308. <span class="md-nav__icon md-icon"></span>
  309. Contributing
  310. </label>
  311. <ul class="md-nav__list" data-md-scrollfix>
  312. <li class="md-nav__item">
  313. <a href="../contributing-devguide/" class="md-nav__link">
  314. Developer guide
  315. </a>
  316. </li>
  317. <li class="md-nav__item md-nav__item--active">
  318. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  319. <label class="md-nav__link md-nav__link--active" for="__toc">
  320. Contributing Process
  321. <span class="md-nav__icon md-icon"></span>
  322. </label>
  323. <a href="./" class="md-nav__link md-nav__link--active">
  324. Contributing Process
  325. </a>
  326. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  327. <label class="md-nav__title" for="__toc">
  328. <span class="md-nav__icon md-icon"></span>
  329. Table of contents
  330. </label>
  331. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  332. <li class="md-nav__item">
  333. <a href="#project-management" class="md-nav__link">
  334. Project Management
  335. </a>
  336. </li>
  337. <li class="md-nav__item">
  338. <a href="#issues" class="md-nav__link">
  339. Issues
  340. </a>
  341. </li>
  342. <li class="md-nav__item">
  343. <a href="#submitting-a-pull-request" class="md-nav__link">
  344. Submitting a Pull Request
  345. </a>
  346. </li>
  347. <li class="md-nav__item">
  348. <a href="#cutting-releases" class="md-nav__link">
  349. Cutting Releases
  350. </a>
  351. </li>
  352. </ul>
  353. </nav>
  354. </li>
  355. <li class="md-nav__item">
  356. <a href="../contributing-coc/" class="md-nav__link">
  357. Code of Conduct
  358. </a>
  359. </li>
  360. </ul>
  361. </nav>
  362. </li>
  363. </ul>
  364. </nav>
  365. </div>
  366. </div>
  367. </div>
  368. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  369. <div class="md-sidebar__scrollwrap">
  370. <div class="md-sidebar__inner">
  371. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  372. <label class="md-nav__title" for="__toc">
  373. <span class="md-nav__icon md-icon"></span>
  374. Table of contents
  375. </label>
  376. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  377. <li class="md-nav__item">
  378. <a href="#project-management" class="md-nav__link">
  379. Project Management
  380. </a>
  381. </li>
  382. <li class="md-nav__item">
  383. <a href="#issues" class="md-nav__link">
  384. Issues
  385. </a>
  386. </li>
  387. <li class="md-nav__item">
  388. <a href="#submitting-a-pull-request" class="md-nav__link">
  389. Submitting a Pull Request
  390. </a>
  391. </li>
  392. <li class="md-nav__item">
  393. <a href="#cutting-releases" class="md-nav__link">
  394. Cutting Releases
  395. </a>
  396. </li>
  397. </ul>
  398. </nav>
  399. </div>
  400. </div>
  401. </div>
  402. <div class="md-content" data-md-component="content">
  403. <article class="md-content__inner md-typeset">
  404. <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">
  405. <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>
  406. </a>
  407. <h1>Contributing Process</h1>
  408. <h2 id="project-management">Project Management</h2>
  409. <p>The Code, our TODOs and Documentation is maintained on
  410. <a href="https://github.com/external-secrets/external-secrets">GitHub</a>. All Issues
  411. should be opened in that repository.</p>
  412. <h2 id="issues">Issues</h2>
  413. <p>Features, bugs and any issues regarding the documentation should be filed as
  414. <a href="https://github.com/external-secrets/external-secrets/issues">GitHub Issue</a> in
  415. our repository. We use labels like <code>kind/feature</code>, <code>kind/bug</code>, <code>area/aws</code> to
  416. organize the issues. Issues labeled <code>good first issue</code> and <code>help wanted</code> are
  417. especially good for a first contribution. If you want to pick up an issue just
  418. leave a comment.</p>
  419. <h2 id="submitting-a-pull-request">Submitting a Pull Request</h2>
  420. <p>This project uses the well-known pull request process from GitHub. To submit a
  421. pull request, fork the repository and push any changes to a branch on the copy,
  422. from there a pull request can be made in the main repo. Merging a pull request
  423. requires the following steps to be completed before the pull request will
  424. be merged:</p>
  425. <ul>
  426. <li>ideally, there is an issue that documents the problem or feature in depth.</li>
  427. <li>code must have a reasonable amount of test coverage</li>
  428. <li>tests must pass</li>
  429. <li>PR needs be reviewed and approved</li>
  430. </ul>
  431. <p>Once these steps are completed the PR will be merged by a code owner.</p>
  432. <h2 id="cutting-releases">Cutting Releases</h2>
  433. <p>As of now this project is in an early alpha phase. There is just the main branch
  434. ;)</p>
  435. </article>
  436. </div>
  437. </div>
  438. </main>
  439. <footer class="md-footer">
  440. <nav class="md-footer__inner md-grid" aria-label="Footer">
  441. <a href="../contributing-devguide/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Developer guide" rel="prev">
  442. <div class="md-footer__button md-icon">
  443. <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>
  444. </div>
  445. <div class="md-footer__title">
  446. <div class="md-ellipsis">
  447. <span class="md-footer__direction">
  448. Previous
  449. </span>
  450. Developer guide
  451. </div>
  452. </div>
  453. </a>
  454. <a href="../contributing-coc/" class="md-footer__link md-footer__link--next" aria-label="Next: Code of Conduct" rel="next">
  455. <div class="md-footer__title">
  456. <div class="md-ellipsis">
  457. <span class="md-footer__direction">
  458. Next
  459. </span>
  460. Code of Conduct
  461. </div>
  462. </div>
  463. <div class="md-footer__button md-icon">
  464. <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>
  465. </div>
  466. </a>
  467. </nav>
  468. <div class="md-footer-meta md-typeset">
  469. <div class="md-footer-meta__inner md-grid">
  470. <div class="md-footer-copyright">
  471. Made with
  472. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  473. Material for MkDocs
  474. </a>
  475. </div>
  476. </div>
  477. </div>
  478. </footer>
  479. </div>
  480. <div class="md-dialog" data-md-component="dialog">
  481. <div class="md-dialog__inner md-typeset"></div>
  482. </div>
  483. <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>
  484. <script src="../assets/javascripts/bundle.76f349be.min.js"></script>
  485. </body>
  486. </html>