Menu

Coding Guidelines

pallab jyotee hazarika SourceForge Editorial Staff

Coding Guidelines

This checklist should be used when contributing code to the Flex SDK:

  • Architecture: Does the code follow the broader architectural design?
  • API: Is the API consistent?
  • Code format and convention: Does the code follow standard formatting and code conventions?
  • Use Cases: Does the code handle all use cases?
  • ASDoc: Do we need to add ASDoc comments?
  • Readability: Is the code understandable/maintainable? Would more comments help?
  • Duplication: Are we duplicating code that could be combined?
  • Backward compatibility: Does the code break backward compatibility?
  • Performance: Does the code minimize memory, swf size, and runtime performance impact?
  • Dependencies: Do the changes introduce undesirable dependencies or layer violations (e.g. link in unnecessary classes into base classes, etc.)?
  • Cross-Platform: Are there cross-platform, cross-browser, or cross-runtime (including AIR) issues to consider?
  • Security: Does the code raise any security issues?

Related

Wiki: Sandbox

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.