ThePain/Swiftgram
1
0
Fork 0
mirror of https://github.com/Swiftgram/Telegram-iOS.git synced 2025-06-16 05:55:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
Swiftgram/submodules/AsyncDisplayKit/docs/_docs/principles.md
Peter 9bc996374f Add 'submodules/AsyncDisplayKit/' from commit '02bedc12816e251ad71777f9d2578329b6d2bef6' 
git-subtree-dir: submodules/AsyncDisplayKit
git-subtree-mainline: d06f423e0ed3df1fed9bd10d79ee312a9179b632
git-subtree-split: 02bedc12816e251ad71777f9d2578329b6d2bef6
2019-06-11 18:42:43 +01:00

2.3 KiB
Executable File
Raw Blame History

title layout permalink
Principles docs /docs/principles.html

The following principles guide the design and development of the Texture framework.

1. Reliable

  • What: Behavior should match the documentation. The framework shouldn't crash in production, even when used incorrectly.
  • Why: If the framework is not reliable, then it cannot be used in production apps. More importantly, it will drain the morale of the engineers working on it.
  • How: Meaningful, stable unit tests. We will devote a significant chunk of our resources to build unit tests.

2. Familiar

  • What: Interfaces should match industry standards such as UIKit and CSS when possible. When we diverge from these standards, the interfaces should as be intuitive and direct as possible.
  • Why: If the framework is not familiar, then companies will be wary about adopting it. Engineers trained in UIKit, especially junior ones, will be frustrated and unproductive.
  • How: Compare API to other mature frameworks, reach out to users when developing new API to get feedback. Be generous with abstraction layers – as long as we don't sacrifice Reliable.

3. Lean

  • What: Speed and memory conservation should be industry-leading, the API should be concise, and implementation code should be short and organized.
  • Why: Performance is at the heart of Texture. It's what we do and we do it better than anyone else. In addition, a concise codebase and API are easier to maintain and learn. Plus it's just the right thing to do.
  • How: Look for opportunities to improve performance. Think about the performance implications of each line of code. Dedicate resources to refactoring. Build tools to gather and expose performance metrics.

4. Bold

  • What: Ambitious features, such as animated layout transitioning or our visibility-depth system, should be added from time to time.
  • Why: Cutting-edge, never-before-seen tech gets people excited about the framework, and can raise the bar for the entire industry. They really move the needle on the user experience in subtle ways. Plus it's fun!
  • How: Propose crazy ideas. See them through – ensure they get into the workflow and get resources allocated for them.