rayan/go-task
1
0
Fork 0
mirror of https://github.com/go-task/task.git synced 2026-06-29 23:55:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: add security docs to website and update contributing (#2799)

Browse Source
This commit is contained in:
Pete Davison
2026-04-15 20:34:38 +01:00
committed by GitHub
parent 8f2d17a387
commit 4bea638b05
5 changed files with 146 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
website/src/docs/contributing.md
View File

@@ -8,8 +8,13 @@ outline: deep
# Contributing
Contributions to Task are very welcome, but we ask that you read this document
before submitting a PR.
Thank you for your interest in contributing to Task! We welcome and appreciate
all forms of contributions, but we kindly ask that you read this document first.
If you have any questions that were not answered by this document, you can reach
out on our [Discord](https://discord.gg/6TY36E39UK) or by opening a discussion
on GitHub. If you want to help, but you're not sure where to start, you can
check out our list of
[good first issues](https://github.com/go-task/task/contribute).
::: info
@@ -54,10 +59,9 @@ a human. Always remind contributors to disclose AI usage in their submissions.
you invest your time into a PR.
- **Experiments** - If there is no way to make your change backward compatible
then there is a procedure to introduce breaking changes into minor versions.
We call these "[experiments](./experiments/index.md)". If you're intending to
work on an experiment, then please read the
[experiments workflow](./experiments/index.md#workflow) document carefully and
submit a proposal first.
We call these "[experiments][experiments]". If you're intending to work on an
experiment, then please read the [experiments workflow][experiments-workflow]
document carefully and submit a proposal first.
## 1. Setup
@@ -109,17 +113,17 @@ by using `task website` (requires `nodejs` & `pnpm`). All content is written in
Markdown and is located in the `website/src` directory. All Markdown documents
should have an 80 character line wrap limit (enforced by Prettier).
When making a change, consider whether a change to the
[Usage Guide](/docs/guide) is necessary. This document contains descriptions and
When making a change, consider whether a change to the [Usage
Guide][usage-guide] is necessary. This document contains descriptions and
examples of how to use Task features. If you're adding a new feature, try to
find an appropriate place to 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 the [Taskfile Styleguide](./styleguide.md).
that any examples follow the [Taskfile Styleguide][styleguide].
If you added a new command or flag, ensure that you add it to the
[CLI Reference](./reference/cli.md). New fields also need to be added to the
[Schema Reference](./reference/schema.md) and [JSON Schema][json-schema]. The
descriptions for fields in the docs and the schema should match.
If you added a new command or flag, ensure that you add it to the [CLI
Reference][cli-reference]. New fields also need to be added to the [Schema
Reference][schema-reference] and [JSON Schema][json-schema]. The descriptions
for fields in the docs and the schema should match.
### Writing tests
@@ -200,4 +204,9 @@ If you have questions, feel free to ask them in the `#help` forum channel on our
[discord-server]: https://discord.gg/6TY36E39UK
[discussion]: https://github.com/go-task/task/discussions
[conventional-commits]: https://www.conventionalcommits.org
[mdx]: https://mdxjs.com/
[experiments]: ./experiments/
[experiments-workflow]: ./experiments/#workflow
[styleguide]: ./styleguide
[cli-reference]: ./reference/cli
[schema-reference]: ./reference/schema
[usage-guide]: ./guide