mirror of
https://github.com/go-task/task.git
synced 2026-06-15 20:01:40 +00:00
deploy: ef9f7af0c5
This commit is contained in:
@@ -12,7 +12,7 @@
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="Task" href="/opensearch.xml">
|
||||
<script src="/js/carbon.js" async></script><title data-rh="true">Contributing | Task</title><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://taskfile.dev/contributing/"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="og:image" content="https://taskfile.dev/img/og-image.png"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Contributing | Task"><meta data-rh="true" name="description" content="Contributions to Task are very welcome, but we ask that you read this document"><meta data-rh="true" property="og:description" content="Contributions to Task are very welcome, but we ask that you read this document"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://taskfile.dev/contributing/"><link data-rh="true" rel="alternate" href="https://taskfile.dev/contributing/" hreflang="en"><link data-rh="true" rel="alternate" href="https://taskfile.dev/contributing/" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://7IZIJ13AI7-dsn.algolia.net" crossorigin="anonymous"><link rel="stylesheet" href="/assets/css/styles.098dd58a.css">
|
||||
<link rel="preload" href="/assets/js/runtime~main.bd011549.js" as="script">
|
||||
<link rel="preload" href="/assets/js/runtime~main.ec420539.js" as="script">
|
||||
<link rel="preload" href="/assets/js/main.7c84d60a.js" as="script">
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
@@ -45,7 +45,7 @@ to add a new section. If you're updating an existing feature, ensure that t
|
||||
documentation and any examples are up-to-date. Ensure that any examples follow
|
||||
the <a href="/styleguide/">Taskfile Styleguide</a>.</p><p>If you added a new field, command or flag, ensure that you add it to the <a href="/api/">API
|
||||
Reference</a>. New fields also need to be added to the
|
||||
<a target="_blank" href="/assets/files/schema-a2ea47008ccde07caab87e7b5eee44dd.json">JSON Schema</a>. The descriptions for fields in the API
|
||||
<a target="_blank" href="/assets/files/schema-45eea8bc2c32fa28a4cb9a20061db5b0.json">JSON Schema</a>. The descriptions for fields in the API
|
||||
reference and the schema should match.</p><h3 class="anchor anchorWithStickyNavbar_mojV" id="writing-tests">Writing tests<a class="hash-link" href="#writing-tests" title="Direct link to heading"></a></h3><p>Most of Task's test are held in the <code>task_test.go</code> file in the project root and
|
||||
this is where you'll most likely want to add new ones too. Most of these tests
|
||||
also have a subdirectory in the <code>testdata</code> directory where any Taskfiles/data
|
||||
@@ -65,7 +65,7 @@ simpler issues that are ideal for first time contributions.</p><p>All kinds of c
|
||||
feature. You can also contribute by upvoting/commenting on issues, helping to
|
||||
answer questions or contributing to other <a href="/community/">community projects</a>.</p><blockquote><p>I'm stuck, where can I get help?</p></blockquote><p>If you have questions, feel free to ask them in the <code>#help</code> channel on our
|
||||
<a href="https://discord.gg/6TY36E39UK" target="_blank" rel="noopener noreferrer">Discord server</a>.</p><hr></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/community/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Community</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/releasing/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Releasing</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_cNA8 thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#before-you-start" class="table-of-contents__link toc-highlight">Before you start</a></li><li><a href="#1-setup" class="table-of-contents__link toc-highlight">1. Setup</a></li><li><a href="#2-making-changes" class="table-of-contents__link toc-highlight">2. Making changes</a><ul><li><a href="#running-your-changes" class="table-of-contents__link toc-highlight">Running your changes</a></li><li><a href="#updating-documentation" class="table-of-contents__link toc-highlight">Updating documentation</a></li><li><a href="#writing-tests" class="table-of-contents__link toc-highlight">Writing tests</a></li></ul></li><li><a href="#3-committing-your-code" class="table-of-contents__link toc-highlight">3. Committing your code</a></li><li><a href="#4-submitting-a-pr" class="table-of-contents__link toc-highlight">4. Submitting a PR</a></li><li><a href="#faq" class="table-of-contents__link toc-highlight">FAQ</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Pages</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/installation/">Installation</a></li><li class="footer__item"><a class="footer__link-item" href="/usage/">Usage</a></li><li class="footer__item"><a class="footer__link-item" href="/donate/">Donate</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/go-task/task" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_I5OW"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/taskfiledev" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_I5OW"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://discord.gg/6TY36E39UK" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_I5OW"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://opencollective.com/task" target="_blank" rel="noopener noreferrer" class="footer__link-item">OpenCollective<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_I5OW"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div></div></footer></div>
|
||||
<script src="/assets/js/runtime~main.bd011549.js"></script>
|
||||
<script src="/assets/js/runtime~main.ec420539.js"></script>
|
||||
<script src="/assets/js/main.7c84d60a.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user