45 lines
No EOL
4.7 KiB
XML
45 lines
No EOL
4.7 KiB
XML
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>alguidelines.dev - Business Central Design Patterns – Templates</title><link>https://alguidelines.dev/docs/contributing/templates/</link><description>Recent content in Templates on alguidelines.dev - Business Central Design Patterns</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://alguidelines.dev/docs/contributing/templates/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs: Title of the Guideline</title><link>https://alguidelines.dev/docs/contributing/templates/guidelines/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/contributing/templates/guidelines/</guid><description>
|
||
<p>This is a guideline, some parts are optional (if there&rsquo;s no content, remove the whole paragraph).</p>
|
||
<p>&lt;<em>Created by (company), Described by (company)</em>&gt;</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>In depth description on what this Pattern is all about</p>
|
||
<ul>
|
||
<li>basic components</li>
|
||
<li>how the interact</li>
|
||
<li>steps to implement</li>
|
||
<li>considerations to take</li>
|
||
</ul>
|
||
<h2 id="bad-code">Bad code</h2>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">PutCodeblocksHere<span style="color:#ce5c00;font-weight:bold">()
|
||
</span></code></pre></div><h2 id="good-code">Good code</h2>
|
||
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-al" data-lang="al">PutCodeblocksHere<span style="color:#ce5c00;font-weight:bold">()
|
||
</span></code></pre></div><h2 id="discussionshttpsgithubcommicrosoftalguidelinesdiscussionscategoriesbc-best-practicesdiscussions_qtitleofyourguidelinegoesherecategory3a22bcbestpractices22"><a href="https://github.com/microsoft/alguidelines/discussions/categories/bc-best-practices?discussions_q=TITLEOFYOURGUIDELINEGOESHERE+category%3A%22BC+Best+Practices%22">Discussions</a></h2>
|
||
<p>&lt;Please replace the &ldquo;TITLEOFYOURGUIDELINEGOESHERE&rdquo; in the link above, with the Title+of+the+Guideline (indeed, with &ldquo;space&rdquo; replaced by a &ldquo;+&quot;) - and remove this line. &gt;</p>
|
||
<p>You can find discussions on all &ldquo;Best Practices&rdquo; <a href="https://github.com/microsoft/alguidelines/discussions/categories/bc-best-practices">here</a>.</p>
|
||
<p>If you don&rsquo;t find the discussion of this guideline, please feel free to create a new one with the same title as this article.</p></description></item><item><title>Docs: Title of the pattern</title><link>https://alguidelines.dev/docs/contributing/templates/patterns/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/contributing/templates/patterns/</guid><description>
|
||
<p>This is a guideline, some parts are optional (if there&rsquo;s no content, remove the whole paragraph).</p>
|
||
<p>&lt;<em>Created by (company), Described by (company)</em>&gt;</p>
|
||
<h2 id="abstract">Abstract</h2>
|
||
<p>Short, descriptive and easy to remember description of this pattern.</p>
|
||
<h2 id="context">Context</h2>
|
||
<p>Sets the stage where the pattern takes place. 1-2 sentences.</p>
|
||
<h2 id="problem">Problem</h2>
|
||
<p>What happens before this pattern is used? How can it go wrong? 1-5 lines.</p>
|
||
<h2 id="description">Description</h2>
|
||
<p>In depth description on what this Pattern is all about</p>
|
||
<ul>
|
||
<li>basic components</li>
|
||
<li>how the interact</li>
|
||
<li>steps to implement</li>
|
||
<li>considerations to take</li>
|
||
</ul>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>If applicable: where is it used in an app. You can refer to any app, BaseApp, or a (public) ISV app.</p>
|
||
<h2 id="benefits">Benefits</h2>
|
||
<p>1-2 sentences: what did you just solve</p>
|
||
<h2 id="when-not-to-use">When not to use</h2>
|
||
<p>Usually, there are occasions where NOT to implement the pattern. List the disadvantages of this pattern here.</p>
|
||
<h2 id="list-of-references">List of references</h2>
|
||
<p>Youtube-link? BaseApp? Tweet? &hellip;</p>
|
||
<h2 id="discussions">Discussions</h2>
|
||
<p>Create a discussions-page of your pattern, and add the sentence &ldquo;You can discuss this pattern <a href="https://github.com/microsoft/alguidelines/discussions/42">here</a>&rdquo; with the right link to that discussions-page.</p></description></item></channel></rss> |