1
0
mirror of https://github.com/go-task/task.git synced 2025-08-10 22:42:19 +02:00

update contributing

This commit is contained in:
Valentin Maerten
2025-08-08 17:26:30 +02:00
parent cbc621330b
commit 051be299cb
5 changed files with 13 additions and 23 deletions

View File

@@ -12,7 +12,6 @@
--vp-icon-details: #6b7280; --vp-icon-details: #6b7280;
} }
.dark { .dark {
--vp-icon-info: #93c5fd; --vp-icon-info: #93c5fd;
--vp-icon-tip: #34d399; --vp-icon-tip: #34d399;
@@ -21,7 +20,6 @@
--vp-icon-details: #9ca3af; --vp-icon-details: #9ca3af;
} }
img[src*='shields.io'] { img[src*='shields.io'] {
display: inline; display: inline;
vertical-align: text-bottom; vertical-align: text-bottom;
@@ -65,7 +63,6 @@ img[src*='custom-icon-badges.demolab.com'] {
animation-delay: 0.3s; animation-delay: 0.3s;
} }
.custom-block .custom-block-title::before { .custom-block .custom-block-title::before {
content: ''; content: '';
display: inline-block; display: inline-block;
@@ -111,13 +108,11 @@ img[src*='custom-icon-badges.demolab.com'] {
transform: rotate(90deg); transform: rotate(90deg);
} }
.custom-block .custom-block-title { .custom-block .custom-block-title {
display: flex; display: flex;
align-items: center; align-items: center;
} }
@supports not (mask-image: none) { @supports not (mask-image: none) {
.custom-block .custom-block-title::before, .custom-block .custom-block-title::before,
.custom-block.details summary::before { .custom-block.details summary::before {
@@ -144,5 +139,4 @@ img[src*='custom-icon-badges.demolab.com'] {
.custom-block.danger .custom-block-title::before { .custom-block.danger .custom-block-title::before {
content: '🔥'; content: '🔥';
} }
} }

View File

@@ -79,17 +79,16 @@ install the extension.
### Updating documentation ### Updating documentation
Task uses [Docusaurus][docusaurus] to host a documentation server. The code for Task uses [Vitepress][vitepress] to host a documentation server. The code for
this is located in the core Task repository. This can be setup and run locally this is located in the core Task repository. This can be setup and run locally
by using `task website` (requires `nodejs` & `yarn`). All content is written in by using `task website` (requires `nodejs` & `pnpm`). All content is written in
[MDX][mdx] (an extension of Markdown) and is located in the `website/docs` Markdown and is located in the `website/src` directory. All Markdown documents
directory. All Markdown documents should have an 80 character line wrap limit should have an 80 character line wrap limit (enforced by Prettier).
(enforced by Prettier).
When making a change, consider whether a change to the [Usage Guide](/usage) When making a change, consider whether a change to the [Usage Guide](/usage) is
is necessary. This document contains descriptions and examples of how to use necessary. This document contains descriptions and examples of how to use Task
Task features. If you're adding a new feature, try to find an appropriate place features. If you're adding a new feature, try to find an appropriate place to
to add a new section. If you're updating an existing feature, ensure that the add a new section. If you're updating an existing feature, ensure that the
documentation and any examples are up-to-date. Ensure that any examples follow documentation and any examples are up-to-date. Ensure that any examples follow
the [Taskfile Styleguide](/styleguide). the [Taskfile Styleguide](/styleguide).
@@ -167,7 +166,7 @@ If you have questions, feel free to ask them in the `#help` forum channel on our
[prettier]: https://prettier.io [prettier]: https://prettier.io
[nodejs]: https://nodejs.org/en/ [nodejs]: https://nodejs.org/en/
[pnpm]: https://pnpm.io/ [pnpm]: https://pnpm.io/
[docusaurus]: https://docusaurus.io [vitepress]: https://vitepress.dev
[json-schema]: [json-schema]:
https://github.com/go-task/task/blob/main/website/static/schema.json https://github.com/go-task/task/blob/main/website/static/schema.json
[task-open-issues]: https://github.com/go-task/task/issues [task-open-issues]: https://github.com/go-task/task/issues

View File

@@ -34,4 +34,3 @@ information.
\{Short explanation of how users should migrate to the new behavior\} \{Short explanation of how users should migrate to the new behavior\}
[enabling-experiments]: /experiments/#enabling-experiments [enabling-experiments]: /experiments/#enabling-experiments

View File

@@ -8,8 +8,7 @@ outline: deep
The following guide will help introduce you to the basics of Task. We'll cover The following guide will help introduce you to the basics of Task. We'll cover
how to create a Taskfile, how to write a basic task and how to call it. If you how to create a Taskfile, how to write a basic task and how to call it. If you
haven't installed Task yet, head over to our haven't installed Task yet, head over to our [installation guide](installation).
[installation guide](installation).
## Creating your first Taskfile ## Creating your first Taskfile
@@ -130,5 +129,5 @@ task build
That's about it for the basics, but there's _so much_ more that you can do with That's about it for the basics, but there's _so much_ more that you can do with
Task. Check out the rest of the documentation to learn more about all the Task. Check out the rest of the documentation to learn more about all the
features Task has to offer! We recommend taking a look at the features Task has to offer! We recommend taking a look at the
[usage guide](usage) next. Alternatively, you can check out our reference [usage guide](usage) next. Alternatively, you can check out our reference docs
docs for the [Taskfile schema](reference/schema) and [CLI](reference/cli). for the [Taskfile schema](reference/schema) and [CLI](reference/cli).

View File

@@ -902,8 +902,7 @@ You can use `--force` or `-f` if you want to force a task to run even when
up-to-date. up-to-date.
Also, `task --status [tasks]...` will exit with a non-zero Also, `task --status [tasks]...` will exit with a non-zero
[exit code](/reference/cli#exit-codes) if any of the tasks are not [exit code](/reference/cli#exit-codes) if any of the tasks are not up-to-date.
up-to-date.
`status` can be combined with the `status` can be combined with the
[fingerprinting](#by-fingerprinting-locally-generated-files-and-their-sources) [fingerprinting](#by-fingerprinting-locally-generated-files-and-their-sources)