2
0

development-workflow.html 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <title>UI Development Workflow :: jMonkeyEngine Docs</title>
  7. <link rel="canonical" href="https://wiki.jmonkeyengine.org/wiki-ui/development-workflow.html">
  8. <link rel="prev" href="build-preview-ui.html">
  9. <link rel="next" href="templates.html">
  10. <meta name="generator" content="Antora 3.0.1">
  11. <link rel="stylesheet" href="../_/css/site.css">
  12. <meta property="og:image" content="https://wiki.jmonkeyengine.org/_/img/iconx128.png">
  13. <meta property="og:description" content="UI Development Workflow">
  14. <meta property="og:title" content="jMonkeyEngine Docs">
  15. <link rel="stylesheet" href="../_/css/site-extra.css">
  16. <link rel="stylesheet" href="../_/css/vendor/docsearch.min.css">
  17. <!-- fetched from https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css -->
  18. <link rel="icon" href="../_/img/favicon.ico" type="image/x-icon">
  19. </head>
  20. <body class="article">
  21. <header class="header">
  22. <nav class="navbar">
  23. <div class="navbar-brand">
  24. <a class="navbar-item" href="https://wiki.jmonkeyengine.org">
  25. <img alt="" src="../_/img/jme-logo.png" height="32" type="image/x-icon">
  26. </a>
  27. <div class="navbar-item hide-for-print">
  28. <input id="search-input" type="text" placeholder="Search docs">
  29. </div>
  30. <button class="navbar-burger" data-target="topbar-nav">
  31. <span></span>
  32. <span></span>
  33. <span></span>
  34. </button>
  35. </div>
  36. <div id="topbar-nav" class="navbar-menu">
  37. <div class="navbar-end">
  38. <div class="navbar-item theme-switch-wrapper">
  39. <label class="theme-switch" for="checkbox">
  40. <input type="checkbox" id="checkbox" />
  41. <div class="slider round"></div>
  42. </label>
  43. </div>
  44. <a class="navbar-item" href="https://github.com/jmonkeyengine/wiki">Github</a>
  45. </div>
  46. </div>
  47. </nav>
  48. </header>
  49. <div class="body">
  50. <div class="nav-container" data-component="wiki-ui" data-version="master">
  51. <aside class="nav">
  52. <div class="panels">
  53. <div class="nav-panel-menu is-active" data-panel="menu">
  54. <nav class="nav-menu">
  55. <h3 class="title"><a href="index.html">Wiki UI</a></h3>
  56. <ul class="nav-list">
  57. <li class="nav-item" data-depth="0">
  58. <ul class="nav-list">
  59. <li class="nav-item" data-depth="1">
  60. <a class="nav-link" href="prerequisites.html">UI Development Prerequisites</a>
  61. </li>
  62. <li class="nav-item" data-depth="1">
  63. <a class="nav-link" href="set-up-project.html">Set up a UI Project</a>
  64. </li>
  65. <li class="nav-item" data-depth="1">
  66. <a class="nav-link" href="build-preview-ui.html">Build and Preview the UI</a>
  67. </li>
  68. <li class="nav-item is-current-page" data-depth="1">
  69. <a class="nav-link" href="development-workflow.html">UI Development Workflow</a>
  70. </li>
  71. <li class="nav-item" data-depth="1">
  72. <a class="nav-link" href="templates.html">Work with the Handlebars Templates</a>
  73. </li>
  74. <li class="nav-item" data-depth="1">
  75. <button class="nav-item-toggle"></button>
  76. <a class="nav-link" href="stylesheets.html">Work with the CSS Stylesheets</a>
  77. <ul class="nav-list">
  78. <li class="nav-item" data-depth="2">
  79. <a class="nav-link" href="add-fonts.html">Add Fonts</a>
  80. </li>
  81. </ul>
  82. </li>
  83. <li class="nav-item" data-depth="1">
  84. <button class="nav-item-toggle"></button>
  85. <a class="nav-link" href="style-guide.html">UI Element Styles</a>
  86. <ul class="nav-list">
  87. <li class="nav-item" data-depth="2">
  88. <a class="nav-link" href="inline-text-styles.html">Inline Text</a>
  89. </li>
  90. <li class="nav-item" data-depth="2">
  91. <a class="nav-link" href="admonition-styles.html">Admonitions</a>
  92. </li>
  93. <li class="nav-item" data-depth="2">
  94. <a class="nav-link" href="list-styles.html">Lists</a>
  95. </li>
  96. <li class="nav-item" data-depth="2">
  97. <a class="nav-link" href="sidebar-styles.html">Sidebars</a>
  98. </li>
  99. <li class="nav-item" data-depth="2">
  100. <a class="nav-link" href="ui-macro-styles.html">UI Macros</a>
  101. </li>
  102. </ul>
  103. </li>
  104. </ul>
  105. </li>
  106. </ul>
  107. </nav>
  108. </div>
  109. <div class="nav-panel-explore" data-panel="explore">
  110. <div class="context">
  111. <span class="title">Wiki UI</span>
  112. <span class="version">master</span>
  113. </div>
  114. <ul class="components">
  115. <li class="component">
  116. <span class="title">JME</span>
  117. <ul class="versions">
  118. <li class="version">
  119. <a href="../docs/3.8/documentation.html">3.8</a>
  120. </li>
  121. <li class="version">
  122. <a href="../docs/3.4/documentation.html">3.4</a>
  123. </li>
  124. <li class="version">
  125. <a href="../docs/3.3/documentation.html">3.3</a>
  126. </li>
  127. <li class="version">
  128. <a href="../docs/3.2/documentation.html">3.2</a>
  129. </li>
  130. </ul>
  131. </li>
  132. <li class="component">
  133. <span class="title">Wiki Contribution</span>
  134. <ul class="versions">
  135. <li class="version">
  136. <a href="../docs-wiki/3.8/wiki_contributor.html">3.8</a>
  137. </li>
  138. </ul>
  139. </li>
  140. <li class="component is-current">
  141. <span class="title">Wiki UI</span>
  142. <ul class="versions">
  143. <li class="version is-current">
  144. <a href="index.html">master</a>
  145. </li>
  146. </ul>
  147. </li>
  148. </ul>
  149. </div>
  150. </div>
  151. </aside>
  152. </div>
  153. <main class="article">
  154. <div class="toolbar" role="navigation">
  155. <button class="nav-toggle"></button>
  156. <nav class="breadcrumbs" aria-label="breadcrumbs">
  157. <ul>
  158. <li><a href="index.html">Wiki UI</a></li>
  159. <li><a href="development-workflow.html">UI Development Workflow</a></li>
  160. </ul>
  161. </nav>
  162. <div class="edit-this-page"><a href="https://github.com/jMonkeyEngine/wiki-ui/edit/master/docs/modules/ROOT/pages/development-workflow.adoc">Edit this Page</a></div>
  163. </div>
  164. <div class="content">
  165. <article class="doc">
  166. <h1 class="page">UI Development Workflow</h1>
  167. <div id="preamble">
  168. <div class="sectionbody">
  169. <div class="paragraph">
  170. <p>All changes pushed to a UI project&#8217;s master branch can trigger a new release (not described here).
  171. Therefore, you want to make your changes to a development branch and submit it as a pull request (PR) to be approved.
  172. (Even better would be to issue the PR from a fork).
  173. Only when the PR is approved and merged will the new release be triggered.</p>
  174. </div>
  175. </div>
  176. </div>
  177. <div class="sect1">
  178. <h2 id="git-steps"><a class="anchor" href="#git-steps"></a>git steps</h2>
  179. <div class="sectionbody">
  180. <div class="paragraph">
  181. <p>Use the following command to create a local development branch named <code>name-me</code>:</p>
  182. </div>
  183. <div class="literalblock">
  184. <div class="content">
  185. <pre>$ git checkout -b name-me -t origin/master</pre>
  186. </div>
  187. </div>
  188. <div class="paragraph">
  189. <p>You&#8217;ll then apply your changes to the UI files.
  190. Once you&#8217;re done making changes, commit those changes to the local branch:</p>
  191. </div>
  192. <div class="literalblock">
  193. <div class="content">
  194. <pre>$ git commit -a -m "describe your change"</pre>
  195. </div>
  196. </div>
  197. <div class="paragraph">
  198. <p>Then, push your branch to the remote repository:</p>
  199. </div>
  200. <div class="literalblock">
  201. <div class="content">
  202. <pre>$ git push origin name-me</pre>
  203. </div>
  204. </div>
  205. <div class="paragraph">
  206. <p>Finally, navigate to your UI project in your browser and create a new pull request from this branch.</p>
  207. </div>
  208. <div class="paragraph">
  209. <p>The maintainer of the UI should review the changes.
  210. If the changes are acceptable, the maintainer will merge the pull request.
  211. As soon as the pull request is merged into master, an automated process will take over to publish a new release for the site generator to use.</p>
  212. </div>
  213. <div class="paragraph">
  214. <p>Now that you&#8217;ve got the process down, let&#8217;s review some of the files you&#8217;ll be working with in more detail.</p>
  215. </div>
  216. </div>
  217. </div>
  218. <nav class="pagination">
  219. <span class="prev"><a href="build-preview-ui.html">Build and Preview the UI</a></span>
  220. <span class="next"><a href="templates.html">Work with the Handlebars Templates</a></span>
  221. </nav>
  222. </article>
  223. <aside class="toc sidebar" data-title="Contents" data-levels="2">
  224. <div class="toc-menu"></div>
  225. </aside>
  226. </div>
  227. </main>
  228. </div>
  229. <footer class="footer">
  230. <p>Copyright 2020 jMonkeyEngine Wiki Contributors. Licensed BSD-3.</p>
  231. </footer>
  232. <script src="../_/js/vendor/docsearch.min.js"></script>
  233. <!-- fetched from https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js -->
  234. <script>
  235. var search = docsearch({
  236. apiKey: 'a736b6d93de805e26ec2f49b55013fbd',
  237. indexName: 'jmonkeyengine',
  238. inputSelector: '#search-input',
  239. autocompleteOptions: { hint: false, keyboardShortcuts: ['s'] },
  240. algoliaOptions: { hitsPerPage: 10 }
  241. }).autocomplete
  242. search.on('autocomplete:closed', function () { search.autocomplete.setVal() })
  243. function focusSearchInput () { document.querySelector('#search-input').focus() }
  244. if (document.querySelector('.home-link.is-current')) window.addEventListener('load', focusSearchInput)
  245. </script>
  246. <script src="../_/js/site.js"></script>
  247. <script async src="../_/js/vendor/highlight.js"></script>
  248. </body>
  249. </html>