indiv0 / conductor-rs Goto Github PK

• Guidelines should be in CONTRIBUTING.md
• README.md should link to the guidelines
• Guidelines should mention:
  • Minimum Rust compiler version necessary
  • CI process
  • PR approval process

A test should be added to ensure that the #[doc(...)] attribute in src/lib.rs points to the correct version of the documentation.

This ensures that the doc attribute is never out of date.

This can be done by adding a version_sync-based test:

#[test]
fn test_html_root_url() {
    version_sync::assert_html_root_url_updated!("src/lib.rs");
}

The #[doc(html_root_url = "...")] attribute should be added to src/lib.rs to ensure that links within the documentation point to the relevant pages on https://docs.rs.

The attribute can be added like so:

#![doc(html_root_url = "https://docs.rs/conductor/0.1.0")]

This attribute cannot be added until ownership of the crate has been transferred, and the documentation has been generated on https://docs.rs.