Deployed 39ee4d5 with MkDocs version: 1.6.0

contribute/index.html → CONTRIBUTING/index.html

@@ -12,4 +12,4 @@
   E --> F[Push Branch];
   F --> K[Create Pull Request];
   K --> L[Fill out PR template];
-  classDef default stroke:#333,stroke-width:4px,font-size:12pt;</code></pre> <div class="admonition info"> <p class=admonition-title>Info</p> <p>This is a diagram to guide you through the process. It may vary depending on the type of change you're making.</p> </div> <h3 id=fork-the-repo>Fork the Repo<a class=headerlink href=#fork-the-repo title="Permanent link">&para;</a></h3> <ul> <li>Fork the WinUtil Repository <a href=https://github.com/ChrisTitusTech/winutil>here</a> to create a copy that will be available in your repository list.</li> </ul> <p><img alt="Fork Image" src=../assets/Fork-Button-Dark.png#only-dark#gh-dark-mode-only></p> <p><img alt="Fork Image" src=../assets/Fork-Button-Light.png#only-light#gh-light-mode-only></p> <h3 id=clone-the-fork>Clone the Fork<a class=headerlink href=#clone-the-fork title="Permanent link">&para;</a></h3> <div class="admonition tip"> <p class=admonition-title>Tip</p> <p>While you can make your changes directly through the Web, we recommend cloning the repo to your device using the application GitHub Desktop (available in WinUtil) to test your fork easily.</p> </div> <ul> <li>Install GitHub Desktop if it is not already installed.</li> <li>Log in using the same GitHub account you used to fork WinUtil.</li> <li>Choose the fork under "Your Repositories" and press "clone {repo name}"</li> <li> <p>Create a new branch and name it something relatable to your changes.</p> </li> <li> <p>Now you can modify WinUtil to your liking using your preferred text editor.</p> </li> </ul> <h3 id=testing-your-changes>Testing your changes<a class=headerlink href=#testing-your-changes title="Permanent link">&para;</a></h3> <ul> <li> <p>To test to see if your changes work as intended run following commands in a powershell teminal as admin:</p> </li> <li> <p>Change the directory where you are running the commands to the forked project.</p> </li> <li><code>cd {path to the folder with the compile.ps1}</code></li> <li>Run the following command to compile and run WinUtil:</li> <li><code>.\Compile.ps1 -run</code></li> </ul> <p><img alt=Compile src=../assets/Compile.png></p> <ul> <li>After seeing that your changes work properly, feel free to commit the changes to the repository and make a PR. For help on that, follow the documentation below.</li> </ul> <h3 id=committing-the-changes>Committing the changes<a class=headerlink href=#committing-the-changes title="Permanent link">&para;</a></h3> <ul> <li>Before committing your changes, please discard changes made to the <code>winutil.ps1</code> file, like the following:</li> </ul> <p><img alt="Push Commit Image" src=../assets/Discard-GHD.png></p> <ul> <li>Now, commit your changes once you are happy with the result.</li> </ul> <p><img alt="Commit Image" src=../assets/Commit-GHD.png></p> <ul> <li>Push the changes to upload them to your fork on github.com.</li> </ul> <p><img alt="Push Commit Image" src=../assets/Push-Commit.png></p> <h3 id=making-a-pr>Making a PR<a class=headerlink href=#making-a-pr title="Permanent link">&para;</a></h3> <ul> <li>To make a PR on your repo under a new branch linking to the main branch, a button will show and say Preview and Create pull request. Click that button and fill in all the information that is provided on the template. Once all the information is filled in correctly, check your PR to make sure there is not a WinUtil.ps1 file attached to the PR. Once everything is good, make the PR and wait for Chris (the maintainer) to accept or deny your PR. Once it is accepted by Chris, you will be able to see your changes in the "/windev" build.</li> <li>If you do not see your feature in the main "/win" build, that is fine. All new changes go into the /windev build to make sure everything is working OK before going fully public.</li> <li>Congratulations! You just submitted your first PR. Thank you so much for contributing to WinUtil.</li> </ul> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 1, 2024</span> </span> </aside> </article> </div> <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var tab,labels=set.querySelector(".tabbed-labels");for(tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> Back to top </button> </main> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "..", "features": ["navigation.tabs", "navigation.sections", "toc.integrate", "navigation.top", "search.suggest", "search.highlight", "content.tabs.link", "content.code.annotation", "content.code.copy"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script> <script src=../assets/javascripts/bundle.fe8b6f2b.min.js></script> </body> </html>
+  classDef default stroke:#333,stroke-width:4px,font-size:12pt;</code></pre> <div class="admonition info"> <p class=admonition-title>Info</p> <p>This is a diagram to guide you through the process. It may vary depending on the type of change you're making.</p> </div> <h3 id=fork-the-repo>Fork the Repo<a class=headerlink href=#fork-the-repo title="Permanent link">&para;</a></h3> <ul> <li>Fork the WinUtil Repository <a href=https://github.com/ChrisTitusTech/winutil>here</a> to create a copy that will be available in your repository list.</li> </ul> <p><img alt="Fork Image" src=../assets/Fork-Button-Dark.png#only-dark#gh-dark-mode-only></p> <p><img alt="Fork Image" src=../assets/Fork-Button-Light.png#only-light#gh-light-mode-only></p> <h3 id=clone-the-fork>Clone the Fork<a class=headerlink href=#clone-the-fork title="Permanent link">&para;</a></h3> <div class="admonition tip"> <p class=admonition-title>Tip</p> <p>While you can make your changes directly through the Web, we recommend cloning the repo to your device using the application GitHub Desktop (available in WinUtil) to test your fork easily.</p> </div> <ul> <li>Install GitHub Desktop if it is not already installed.</li> <li>Log in using the same GitHub account you used to fork WinUtil.</li> <li>Choose the fork under "Your Repositories" and press "clone {repo name}"</li> <li> <p>Create a new branch and name it something relatable to your changes.</p> </li> <li> <p>Now you can modify WinUtil to your liking using your preferred text editor.</p> </li> </ul> <h3 id=testing-your-changes>Testing your changes<a class=headerlink href=#testing-your-changes title="Permanent link">&para;</a></h3> <ul> <li> <p>To test to see if your changes work as intended run following commands in a powershell teminal as admin:</p> </li> <li> <p>Change the directory where you are running the commands to the forked project.</p> </li> <li><code>cd {path to the folder with the compile.ps1}</code></li> <li>Run the following command to compile and run WinUtil:</li> <li><code>.\Compile.ps1 -run</code></li> </ul> <p><img alt=Compile src=../assets/Compile.png></p> <ul> <li>After seeing that your changes work properly, feel free to commit the changes to the repository and make a PR. For help on that, follow the documentation below.</li> </ul> <h3 id=committing-the-changes>Committing the changes<a class=headerlink href=#committing-the-changes title="Permanent link">&para;</a></h3> <ul> <li>Before committing your changes, please discard changes made to the <code>winutil.ps1</code> file, like the following:</li> </ul> <p><img alt="Push Commit Image" src=../assets/Discard-GHD.png></p> <ul> <li>Now, commit your changes once you are happy with the result.</li> </ul> <p><img alt="Commit Image" src=../assets/Commit-GHD.png></p> <ul> <li>Push the changes to upload them to your fork on github.com.</li> </ul> <p><img alt="Push Commit Image" src=../assets/Push-Commit.png></p> <h3 id=making-a-pr>Making a PR<a class=headerlink href=#making-a-pr title="Permanent link">&para;</a></h3> <ul> <li>To make a PR on your repo under a new branch linking to the main branch, a button will show and say Preview and Create pull request. Click that button and fill in all the information that is provided on the template. Once all the information is filled in correctly, check your PR to make sure there is not a WinUtil.ps1 file attached to the PR. Once everything is good, make the PR and wait for Chris (the maintainer) to accept or deny your PR. Once it is accepted by Chris, you will be able to see your changes in the "/windev" build.</li> <li>If you do not see your feature in the main "/win" build, that is fine. All new changes go into the /windev build to make sure everything is working OK before going fully public.</li> <li>Congratulations! You just submitted your first PR. Thank you so much for contributing to WinUtil.</li> </ul> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 7, 2024</span> </span> </aside> </article> </div> <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var tab,labels=set.querySelector(".tabbed-labels");for(tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> Back to top </button> </main> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "..", "features": ["navigation.tabs", "navigation.sections", "toc.integrate", "navigation.top", "search.suggest", "search.highlight", "content.tabs.link", "content.code.annotation", "content.code.copy"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script> <script src=../assets/javascripts/bundle.fe8b6f2b.min.js></script> </body> </html>