Skip to content
This repository has been archived by the owner on Aug 3, 2024. It is now read-only.

Pre-flight check #173

Open
1 of 15 tasks
Timidger opened this issue May 30, 2018 · 0 comments
Open
1 of 15 tasks

Pre-flight check #173

Timidger opened this issue May 30, 2018 · 0 comments
Milestone

Comments

@Timidger
Copy link
Member

Timidger commented May 30, 2018

This is a list of things to double check and sign off on before 1.0.

  • Implement Copy on everything that's reasonable.
  • Implement Clone on everything that's reasonable.
  • Implement Hash, Eq, PartialEq, Debug, and Display on everything.
  • Document every model.
  • Document every public structure.
  • Document every public function.
  • Run a (stable) rustfmt on the codebase.
  • Run clippy on the codebase and fix all warnings.
    • Pre-pre-check: Configure clippy.
  • Allow (unsafe) raw access of every structure so the user can access things we don't expose safely
    • This means that, with some exceptions, we don't have to re-export unsafe fields or functions and can simply let the user access them by using the raw pointer. Terms and conditions apply, check inside the codebase for more details.
  • Look at the header files for every file and ensure every function and field is accessible:
  • Ensure builds on *BSD.
    • Might need to add meson build -D b_lundef=false.
  • Add unstable build flag.
  • No TODOs or FIXMEs (enforced by build server).
  • Ensure C types are used to proprely encode architecture specific types (e.g. int, double, etc.)
@Timidger Timidger added this to the 1.0 milestone May 30, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

No branches or pull requests

1 participant