Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

C-METADATA: Change authors field to optional #266

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,17 +183,17 @@ all the things"].
The `[package]` section of `Cargo.toml` should include the following
values:

- `authors`
- `description`
- `license`
- `repository`
- `keywords`
- `categories`

In addition, there are two optional metadata fields:
In addition, there are three optional metadata fields:

- `documentation`
- `homepage`
- `authors`

By default, *crates.io* links to documentation for the crate on [*docs.rs*]. The
`documentation` metadata only needs to be set if the documentation is hosted
Expand All @@ -207,6 +207,10 @@ crate other than the source repository or API documentation. Do not make
`homepage` redundant with either the `documentation` or `repository` values. For
example, serde sets `homepage` to *https://serde.rs*, a dedicated website.

The `authors` metadata only needs to be set if the crate uses the information
directly, for example in the help text of a command-line binary. Neither
*crates.io* nor *docs.rs* use this metadata field for authorship information.

<a id="c-relnotes"></a>
## Release notes document all significant changes (C-RELNOTES)

Expand Down