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

Code health #15

Open
13 tasks
alalamav opened this issue Apr 3, 2017 · 1 comment
Open
13 tasks

Code health #15

alalamav opened this issue Apr 3, 2017 · 1 comment

Comments

@alalamav
Copy link
Contributor

alalamav commented Apr 3, 2017

  • Remove/refactor any extraneous/legacy cruft (e.g. Psiphon-specific stuff?)
  • Refactor any spaghetti, non-DRY, or error-prone code
  • Grab any config-type values (e.g. DNS resolver address) from config rather than hard-coding
  • Adopt suggestions from https://github.com/akullpp/awesome-java and https://github.com/aleksandar-todorovic/awesome-c that would be helpful
  • Unit, functional, fuzz, and/or property-based tests
  • Continuous Integration (+ status badge link in README if possible). Make sure all of the following run successfully:
    • Linter
    • Automated tools to catch memory-safety issues and other issues not caught be the compiler
    • Building the code for all important targets
    • Automated tests
  • Code coverage (+ status badge link in README if possible)
  • Javadoc comments for public interfaces
    • Generate html documentation (+ status badge link in README if possible)
  • Standardize return 0|1 statements
@jab jab mentioned this issue Apr 4, 2017
@jab
Copy link
Collaborator

jab commented Apr 12, 2017

Migrated much of this to https://buganizer.corp.google.com/issues/37267129, but a few things are specific to this codebase. So leaving this open here too, until those are migrated to Buganizer or fixed on master.

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

No branches or pull requests

2 participants