Road to v1

[HadrienG2]

While I have commented on several other issues about what's needed before a final v1 release, I just realized that a single issue that centralizes this knowledge would make this info more visible, so here goes.

Before releasing v1.0.0 of hwlocality and expending more energy on advertising this project to the world, I want to...

• Fix the enum forward compatibility issue described in Got unknown object type from hwloc_get_depth_type #259 for good
• Have tests for all modules. => Most of them are now done, only object distances left to go.
• Do a last round of API review to make sure I'm comfortable with stabiizing this API.
  • Error handling in particular could use some extra care, IIRC I still have some panics in places that should return Result.
  • Cross-check that common traits are implemented where sensible/possible for idiomatic ergonomics and add static assertions for that.
• Add community-oriented docs.
  • Changelog.
  • Contribution guide.
  • Architecture overview.
  • See openSSF best practices checklist for more inspiration.
• Have more usage examples in the docs.
• Have a checklist for future releases.

...and I think that's it. Will expand if anything else comes to mind.

[HadrienG2]

LWN recently published another interesting article on what to put inside of a contribution policy (requires subscription): https://lwn.net/Articles/971817/ .