OGS-Main/ogs-site
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Publish 2018-06-27 Example-driven development article

Browse Source
This commit is contained in:
Михаил Капелько
2018-06-27 11:18:30 +03:00
parent 42908c0eca
commit 8f5eb01ee4
22 changed files with 1000 additions and 267 deletions
Download Patch File Download Diff File Expand all files Collapse all files

91
feeds/all.atom.xml
View File

@@ -1,5 +1,94 @@
<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"><title>Opensource Game Studio</title><link href="http://opengamestudio.org/" rel="alternate"></link><link href="http://opengamestudio.org/feeds/all.atom.xml" rel="self"></link><id>http://opengamestudio.org/</id><updated>2018-04-20T00:00:00+03:00</updated><entry><title>OpenSceneGraph cross-platform examples</title><link href="http://opengamestudio.org/openscenegraph-examples.html" rel="alternate"></link><updated>2018-04-20T00:00:00+03:00</updated><author><name>Opensource Game Studio</name></author><id>tag:opengamestudio.org,2018-04-20:openscenegraph-examples.html</id><summary type="html">&lt;p&gt;&lt;img alt="Screenshot" src="http://opengamestudio.org/2018-04-20-openscenegraph-examples.png" /&gt;&lt;/p&gt;
<feed xmlns="http://www.w3.org/2005/Atom"><title>Opensource Game Studio</title><link href="http://opengamestudio.org/" rel="alternate"></link><link href="http://opengamestudio.org/feeds/all.atom.xml" rel="self"></link><id>http://opengamestudio.org/</id><updated>2018-06-27T00:00:00+03:00</updated><entry><title>Example-driven development</title><link href="http://opengamestudio.org/example-driven-development.html" rel="alternate"></link><updated>2018-06-27T00:00:00+03:00</updated><author><name>Opensource Game Studio</name></author><id>tag:opengamestudio.org,2018-06-27:example-driven-development.html</id><summary type="html">&lt;p&gt;&lt;img alt="Screenshot" src="http://opengamestudio.org/2018-06-27-example-driven-development.png" /&gt;&lt;/p&gt;
&lt;p&gt;This article explains how the third OpenSceneGraph cross-platform example
opened our eyes to example-driven development.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;The third OpenSceneGraph cross-platform example&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The third OpenSceneGraph cross-platform example explains how to implement
&lt;a href="https://github.com/OGStudio/openscenegraph-cross-platform-examples/tree/master/03.RemoteDebugging"&gt;remote debugging across platforms&lt;/a&gt;. This example is less about
OpenSceneGraph and more about different platforms.&lt;/p&gt;
&lt;p&gt;Remote anything nowadays assumes the use of HTTP(s) over TCP/IP. Thus, the
first idea was to embed HTTP server into an application and let HTTP clients
interact with the server. However, serving HTTP across all platforms is
complicated:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;desktops have firewalls&lt;/li&gt;
&lt;li&gt;mobiles have restrictions on background processes&lt;/li&gt;
&lt;li&gt;web browsers are HTTP clients by design&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;That's why we decided to create a mediator between debugged application and UI.
&lt;a href="https://github.com/OGStudio/debug-broker"&gt;Debug broker&lt;/a&gt;, a small Node.js application, became that mediator.
Debug broker uses no external dependencies, so it's easy to run virtually
anywhere. Also, since debug broker is a server application, you can configure
it once and use it for any number of applications.&lt;/p&gt;
&lt;p&gt;Both &lt;a href="https://github.com/OGStudio/debug-ui"&gt;debug UI&lt;/a&gt; and &lt;a href="https://github.com/OGStudio/debug-broker"&gt;debug broker&lt;/a&gt; use JavaScript
because we wanted these tools to be accessible from anywhere with no prior
installation. This decision limited us to web browser solution. Providing
any sort of desktop application would incur additional installation and
maintenance effort, which would only complicate the tools.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Example-driven development establishment&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Once the third example was implemented, we realized how important and
beneficial it is to develop new features outside the main project:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;the main project is freed from excessive commit noise&lt;/li&gt;
&lt;li&gt;a new feature is publicly shared for everyone to learn, criticize, and improve&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;When we publicly share our knowledge:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;we must create documentation for everyone (including ourselves later) to understand what's going on&lt;/li&gt;
&lt;li&gt;we must not use hacks because that would break your trust in us&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;From now on, all new features like input handling, Mahjong layout loading,
resource caching, etc. are going to be first implemented as examples.
We call this example-driven development.&lt;/p&gt;
&lt;p&gt;That's it for explaining how the third OpenSceneGraph cross-platform example
opened our eyes to example-driven development.&lt;/p&gt;</summary></entry><entry><title>Разработка через создание примеров</title><link href="http://opengamestudio.org/example-driven-development-ru.html" rel="alternate"></link><updated>2018-06-27T00:00:00+03:00</updated><author><name>Opensource Game Studio</name></author><id>tag:opengamestudio.org,2018-06-27:example-driven-development-ru.html</id><summary type="html">&lt;p&gt;&lt;img alt="Screenshot" src="http://opengamestudio.org/2018-06-27-example-driven-development.png" /&gt;&lt;/p&gt;
&lt;p&gt;Эта статья описывает то, как создание третьего кросс-платформенного примера
OpenSceneGraph привело нас к разработке через создание примеров.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Третий кросс-платформенный пример OpenSceneGraph&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Третий кросс-платформенный пример OpenSceneGraph содержит реализацию
&lt;a href="https://github.com/OGStudio/openscenegraph-cross-platform-examples/tree/master/03.RemoteDebugging"&gt;удалённой отладки, работающей на всех поддерживаемых платформах&lt;/a&gt;.
Этот пример относится не столько к OpenSceneGraph, сколько к поддержке
различных платформ.&lt;/p&gt;
&lt;p&gt;Удалённое взаимодействие ныне предполагает использование HTTP(s) поверх
TCP/IP. Таким образом, первая идея реализации подразумевала встраивание сервера
HTTP в приложение, чтобы клиенты HTTP могли взаимодействовать с этим сервером.
Однако, раздача HTTP на различных платформах имеет свои сложности:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;на десктопах есть межсетевые экраны (firewalls)&lt;/li&gt;
&lt;li&gt;на мобилках есть ограничения по работе фоновых процессов&lt;/li&gt;
&lt;li&gt;веб-браузеры являются клиентами HTTP по дизайну&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;Эти ограничения подтолкнули нас к созданию посредника между отлаживаемым
приложением и пользовательским интерфейсом отладки.
&lt;a href="https://github.com/OGStudio/debug-broker"&gt;Брокер отладки&lt;/a&gt;, небольшое приложение Node.js, стало тем самым
посредником. Брокер отладки не имеет внешних зависимостей, поэтому его легко
использовать практически везде. Благодаря тому, что брокер отладки - это
серверное приложение, его достаточно настроить лишь раз и использовать для
любого количества приложений.&lt;/p&gt;
&lt;p&gt;И &lt;a href="https://github.com/OGStudio/debug-ui"&gt;пользовательский интерфейс отладки&lt;/a&gt;,
и &lt;a href="https://github.com/OGStudio/debug-broker"&gt;брокер отладки&lt;/a&gt; используют JavaScript, т.к. мы хотели сделать
эти инструменты максимально доступными без предварительной установки. Данное
решение привело нас к реализации инструментов именно для веб-браузеров.
Десктопное приложение потребовало бы дополнительных усилий на установку и
поддержку, что лишь усложнило бы работу с инструментами.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Разработка через создание примеров&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;После создания третьего примера мы осознали важность и достоинства разработки
новых функций вне основного проекта:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;освобождение основного проекта от шума изменений (commit noise)&lt;/li&gt;
&lt;li&gt;публичное освещение новой функции приглашает всех к её изучению, критике и улучшению&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;Когда мы делимся нашими знаниями:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;мы обязаны создавать документацию, объясняющую происходящее (в том числе для нас самих позже)&lt;/li&gt;
&lt;li&gt;мы обязаны сторониться непродуманных решений, т.к. они повредят нашей репутации&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;С этого момента все новые функции вроде обработки ввода, загрузки раскладок
Маджонга, кэширования ресурсов и т.п. мы будем сначала реализовывать в виде
примеров. Мы называем этот подход разработкой через создание примеров.&lt;/p&gt;
&lt;p&gt;На этом мы заканчиваем описание того, как создание третьего
кросс-платформенного примера OpenSceneGraph привело нас к разработке через
создание примеров.&lt;/p&gt;</summary></entry><entry><title>OpenSceneGraph cross-platform examples</title><link href="http://opengamestudio.org/openscenegraph-examples.html" rel="alternate"></link><updated>2018-04-20T00:00:00+03:00</updated><author><name>Opensource Game Studio</name></author><id>tag:opengamestudio.org,2018-04-20:openscenegraph-examples.html</id><summary type="html">&lt;p&gt;&lt;img alt="Screenshot" src="http://opengamestudio.org/2018-04-20-openscenegraph-examples.png" /&gt;&lt;/p&gt;
&lt;p&gt;This article summarizes the work we did to produce the first two
cross-platform OpenSceneGraph examples.&lt;/p&gt;
&lt;p&gt;By the time &lt;a href="http://opengamestudio.org/mahjong-techdemo1-gameplay.html"&gt;the first technology demonstration of OGS Mahjong 2&lt;/a&gt;

44
feeds/news.atom.xml
View File

@@ -1,5 +1,47 @@
<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"><title>Opensource Game Studio</title><link href="http://opengamestudio.org/" rel="alternate"></link><link href="http://opengamestudio.org/feeds/news.atom.xml" rel="self"></link><id>http://opengamestudio.org/</id><updated>2018-04-20T00:00:00+03:00</updated><entry><title>OpenSceneGraph cross-platform examples</title><link href="http://opengamestudio.org/openscenegraph-examples.html" rel="alternate"></link><updated>2018-04-20T00:00:00+03:00</updated><author><name>Opensource Game Studio</name></author><id>tag:opengamestudio.org,2018-04-20:openscenegraph-examples.html</id><summary type="html">&lt;p&gt;&lt;img alt="Screenshot" src="http://opengamestudio.org/2018-04-20-openscenegraph-examples.png" /&gt;&lt;/p&gt;
<feed xmlns="http://www.w3.org/2005/Atom"><title>Opensource Game Studio</title><link href="http://opengamestudio.org/" rel="alternate"></link><link href="http://opengamestudio.org/feeds/news.atom.xml" rel="self"></link><id>http://opengamestudio.org/</id><updated>2018-06-27T00:00:00+03:00</updated><entry><title>Example-driven development</title><link href="http://opengamestudio.org/example-driven-development.html" rel="alternate"></link><updated>2018-06-27T00:00:00+03:00</updated><author><name>Opensource Game Studio</name></author><id>tag:opengamestudio.org,2018-06-27:example-driven-development.html</id><summary type="html">&lt;p&gt;&lt;img alt="Screenshot" src="http://opengamestudio.org/2018-06-27-example-driven-development.png" /&gt;&lt;/p&gt;
&lt;p&gt;This article explains how the third OpenSceneGraph cross-platform example
opened our eyes to example-driven development.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;The third OpenSceneGraph cross-platform example&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The third OpenSceneGraph cross-platform example explains how to implement
&lt;a href="https://github.com/OGStudio/openscenegraph-cross-platform-examples/tree/master/03.RemoteDebugging"&gt;remote debugging across platforms&lt;/a&gt;. This example is less about
OpenSceneGraph and more about different platforms.&lt;/p&gt;
&lt;p&gt;Remote anything nowadays assumes the use of HTTP(s) over TCP/IP. Thus, the
first idea was to embed HTTP server into an application and let HTTP clients
interact with the server. However, serving HTTP across all platforms is
complicated:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;desktops have firewalls&lt;/li&gt;
&lt;li&gt;mobiles have restrictions on background processes&lt;/li&gt;
&lt;li&gt;web browsers are HTTP clients by design&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;That's why we decided to create a mediator between debugged application and UI.
&lt;a href="https://github.com/OGStudio/debug-broker"&gt;Debug broker&lt;/a&gt;, a small Node.js application, became that mediator.
Debug broker uses no external dependencies, so it's easy to run virtually
anywhere. Also, since debug broker is a server application, you can configure
it once and use it for any number of applications.&lt;/p&gt;
&lt;p&gt;Both &lt;a href="https://github.com/OGStudio/debug-ui"&gt;debug UI&lt;/a&gt; and &lt;a href="https://github.com/OGStudio/debug-broker"&gt;debug broker&lt;/a&gt; use JavaScript
because we wanted these tools to be accessible from anywhere with no prior
installation. This decision limited us to web browser solution. Providing
any sort of desktop application would incur additional installation and
maintenance effort, which would only complicate the tools.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Example-driven development establishment&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Once the third example was implemented, we realized how important and
beneficial it is to develop new features outside the main project:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;the main project is freed from excessive commit noise&lt;/li&gt;
&lt;li&gt;a new feature is publicly shared for everyone to learn, criticize, and improve&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;When we publicly share our knowledge:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;we must create documentation for everyone (including ourselves later) to understand what's going on&lt;/li&gt;
&lt;li&gt;we must not use hacks because that would break your trust in us&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;From now on, all new features like input handling, Mahjong layout loading,
resource caching, etc. are going to be first implemented as examples.
We call this example-driven development.&lt;/p&gt;
&lt;p&gt;That's it for explaining how the third OpenSceneGraph cross-platform example
opened our eyes to example-driven development.&lt;/p&gt;</summary></entry><entry><title>OpenSceneGraph cross-platform examples</title><link href="http://opengamestudio.org/openscenegraph-examples.html" rel="alternate"></link><updated>2018-04-20T00:00:00+03:00</updated><author><name>Opensource Game Studio</name></author><id>tag:opengamestudio.org,2018-04-20:openscenegraph-examples.html</id><summary type="html">&lt;p&gt;&lt;img alt="Screenshot" src="http://opengamestudio.org/2018-04-20-openscenegraph-examples.png" /&gt;&lt;/p&gt;
&lt;p&gt;This article summarizes the work we did to produce the first two
cross-platform OpenSceneGraph examples.&lt;/p&gt;
&lt;p&gt;By the time &lt;a href="http://opengamestudio.org/mahjong-techdemo1-gameplay.html"&gt;the first technology demonstration of OGS Mahjong 2&lt;/a&gt;