- Learning from Open Source: Code Catalog is a collection of instructive code examples with annotations. Examples are from popular open-source projects, are instructive (solve general problems), mostly self-contained, small-ish (readable in one sitting), non-trivial, and good code.
- Catalog: A list of various code examples including titles, projects, languages, and tags such as "Downloading Software From a Variety of Sources" with Homebrew, Ruby, and #strategy #template-method, etc.
FAQ:
- Why do we need this?: Reading other people's code is a common way to get better at coding, but understanding established open source codebases is hard. Code Catalog makes it easier by finding, explaining, and categorizing examples.
- Who is this project for?: Software practitioners and intermediate+ learners of programming who can read non-trivial code in the example's language and have little domain knowledge.
- What can I learn from this?: Style and best practices, applications of common patterns, and battle-tested solutions.
- Why so few examples?: Finding suitable examples is time-consuming. More are being added; see proposed examples.
- Who writes these articles?: The founder Anton Emelyanov, and future content is expected to be crowd-sourced. Be cautious as the article author's understanding may be incomplete or wrong.
- Why did you choose a specific example?: Because it meets the criteria. Suggest adding more examples at suggest adding another example.
- Contributing: Volunteer effort is needed. Read the contributing guide for details on improving existing or adding new articles.
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。