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

Add recommended metadata to Cargo.toml #107

Merged
merged 2 commits into from
Jul 9, 2018
Merged

Add recommended metadata to Cargo.toml #107

merged 2 commits into from
Jul 9, 2018

Conversation

afck
Copy link
Collaborator

@afck afck commented Jul 4, 2018

The Rust API guidelines recommend a set of metadata values:
https://rust-lang-nursery.github.io/api-guidelines/documentation.html#c-metadata
(See #108)

@afck afck requested review from vkomenda and igorbarinov July 4, 2018 11:01
@afck
Copy link
Collaborator Author

afck commented Jul 4, 2018

There's also an optional "homepage" link; not sure whether it would make sense to link to e.g. https://poa.network/ from the crates.io page, though.

@igorbarinov
Copy link
Member

igorbarinov commented Jul 4, 2018 via email

@afck
Copy link
Collaborator Author

afck commented Jul 4, 2018

OK, then we don't have to add the "homepage" field, as it links to the "repository" one by default anyway.

Cargo.toml Outdated
@@ -2,6 +2,15 @@
name = "hbbft"
version = "0.1.0"
authors = ["Vladimir Komendantskiy <komendantsky@gmail.com>"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's update authors too.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add all of us individually, or rather a single POA email address?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right, as the team grows, we might need to follow the example of other projects, e.g.,

authors = ["Parity Technologies <admin@parity.io>"]

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@igorbarinov: Is there some email address like that, which we should use as "the author"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I extended the authors list.

@vkomenda vkomenda merged commit 68d5d08 into master Jul 9, 2018
@afck afck deleted the afck-cargo-toml branch July 10, 2018 12:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants