Moving contributing

This commit is contained in:
Jeremy Vyska 2022-02-20 20:58:53 +01:00
parent 871c538bfd
commit 3d0cb3a40b
9 changed files with 22 additions and 22 deletions

View file

@ -0,0 +1,36 @@
+++
title = "Title of the Guideline"
weight = 1180
+++
This is a guideline, some parts are optional (if there's no content, remove the whole paragraph).
<_Created by (company), Described by (company)_\>
## Description
In depth description on what this Pattern is all about
- basic components
- how the interact
- steps to implement
- considerations to take
## Bad code
```al
PutCodeblocksHere()
```
## Good code
```al
PutCodeblocksHere()
```
## [Discussions](https://github.com/microsoft/alguidelines/discussions/categories/bc-best-practices?discussions_q=TITLEOFYOURGUIDELINEGOESHERE+category%3A%22BC+Best+Practices%22)
<Please replace the "TITLEOFYOURGUIDELINEGOESHERE" in the link above, with the Title+of+the+Guideline (indeed, with "space" replaced by a "+") - and remove this line. \>
You can find discussions on all "Best Practices" [here](https://github.com/microsoft/alguidelines/discussions/categories/bc-best-practices).
If you don't find the discussion of this guideline, please feel free to create a new one with the same title as this article.

View file

@ -0,0 +1,47 @@
+++
title = "Title of the pattern"
weight = 1180
+++
This is a guideline, some parts are optional (if there's no content, remove the whole paragraph).
<_Created by (company), Described by (company)_\>
## Abstract
Short, descriptive and easy to remember description of this pattern.
## Context
Sets the stage where the pattern takes place. 1-2 sentences.
## Problem
What happens before this pattern is used? How can it go wrong? 1-5 lines.
## Description
In depth description on what this Pattern is all about
- basic components
- how the interact
- steps to implement
- considerations to take
## Usage
If applicable: where is it used in an app. You can refer to any app, BaseApp, or a (public) ISV app.
## Benefits
1-2 sentences: what did you just solve
## When not to use
Usually, there are occasions where NOT to implement the pattern. List the disadvantages of this pattern here.
## List of references
Youtube-link? BaseApp? Tweet? ...
## Discussions
Create a discussions-page of your pattern, and add the sentence "You can discuss this pattern [here](https://github.com/microsoft/alguidelines/discussions/42)" with the right link to that discussions-page.

View file

@ -0,0 +1,14 @@
+++
chapter = true
pre = "<b><i class='fas fa-clone'></i> </b>"
title = "Templates"
weight = 100
+++
# Templates
We have foreseen some template-files that you can simply copy and use. Look at them as "Patterns for describing patterns" 😉.
We have foreseen a Template:
- for [patterns](/contributing/templates/patterns/)
- for [guidelines](/contributing/templates/guidelines/)