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

Audit AllegroFlare #68

Open
MarkOates opened this issue Jun 9, 2016 · 0 comments

Comments

Projects
None yet
1 participant
@MarkOates
Copy link
Owner

commented Jun 9, 2016

Do a complete, comprehensive, line-item audit for each component in the source code. The audit should contain a complete list of each component (Maybe in the docs sql table), and a series of checkboxes marking the status of each component:

  • Formatted with proper style
  • Useful (generally a practical component and not duplicating functionality from other, better components)
  • No stray //commented code
  • Contains no //todo or //might do this differently comments
  • Has no publically accessible elements that should not be exposed
  • Has appropriate accessor functions
  • Well-written (meets a minimum of code design/archetecture quality)
  • No incomplete code (does not have any blank or unfinished functions)
  • Functionally viable (it has at least a minimum viable set of functions for its primary use case)
  • Functionally complete (it has a "complete" set of functions, all known use case concerns have been addressed)
  • Tested
  • Complemented by an example program in examples/
  • Documented functionally in header files
  • Documented in a tutorial

The audit should be completed and available in the release of 0.8.9, completing all the items on the audit list would vindicate the release of 0.9.0. 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.