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

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.1 KiB

View file

@ -0,0 +1,63 @@
+++
chapter = true
pre = "<b><i class='fas fa-clone'></i> </b>"
title = "Guide to Fork & PR"
weight = 100
+++
## Abstract
AL Guidelines is a community project, and as such YOU are encouraged to submit corrections and new ideas. In order to get your content included, you must submit a pull request to the GitHub Repository (Located here: https://github.com/microsoft/alguidelines\). All Pull Requests are subject to approval by a minimum of three admins.
If You are toying with an idea, but You aren't ready to create a document just yet, you are encouraged to create a project discussion thread here: https://github.com/microsoft/alguidelines/discussions
{{% alert title="Warning" color="warning" %}}
This is a warning.
If You haven't worked in collaboration with "external" GitHub repositories before, please familiarize yourself with that process by visiting:
https://docs.github.com/en/pull-requests/collaborating-with-pull-requests
{{% /alert %}}
## Steps
Now that You have decided that You are ready to contribute, these are the steps to take.
{{% alert title="Note" color="info" %}}
You can read more about this process here:
https://docs.github.com/en/get-started/quickstart/contributing-to-projects
{{% /alert %}}
### Step 1: Fork
In order to work on the repository, You must [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository.
By forking the repository, You essentially create a copy into Your own account.
Start by going to the GitHub Repository (https://github.com/microsoft/alguidelines\), and press the Fork ![Fork Button](./fork_button.jpg "Fork")
Once You have successfully forked the repository, go to your own GitHub repository : ![Forked Repository Representation](./ForkedRepro.png "Forked repository")
You are now able to clone your own repository to your local pc and start editing using your favorite editor. [Visual Studio Code](https://code.visualstudio.com/) is perfectly fine for this task.
{{% alert title="Note" color="info" %}}
You can read more about forking here:
https://docs.github.com/en/get-started/quickstart/fork-a-repo
{{% /alert %}}
### Step 2: Branch
While not necessarily a must, it is always good practice to create a branch off of your forked repository. That will allow you to work on multiple contributions at the same time and won't have to wait for pull requests to be approved before you can continue on your next contribution.
{{% alert title="Note" color="info" %}}
You can read more about Branches here:
https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches
{{% /alert %}}
### Step 3: Pull Request
Once you are happy with your contribution, it's time to create a pull request to propose changes into the main project! This is the final step in producing a fork of someone else's project, and arguably the most important. If you've made a change that you feel would benefit the community as a whole, you should definitely consider contributing back.
To do so, head on over to the repository on GitHub where your project lives. For this example, it would be at `https://www.github.com/<your_username>/alguidelines`. You'll see a banner indicating that your branch is one commit ahead of microsoft:main. Click **Contribute** and then **Open a pull request.**
GitHub will bring you to a page that shows the differences between your fork and the microsoft/alguidelines repository. Click **Create pull request.**
GitHub will bring you to a page where you can enter a title and a description of your changes. _It's important to provide as much useful information and a rationale for why you're making this pull request in the first place._ The project owners needs to be able to determine whether your change is as useful to everyone as you think it is. Finally, click **Create pull request.**

View file

@ -0,0 +1,66 @@
+++
chapter = true
pre = "<b><i class='fas fa-clone'></i> </b>"
title = "Formatting tips"
weight = 100
+++
# Tips and tricks in terms of working with MarkDown and Hugo
## Markdown Cheat Sheet
Here you can find a rather interesting Cheat Sheet regarding markdown: [https://www.markdownguide.org/cheat-sheet](https://www.markdownguide.org/cheat-sheet)
## Code Fences / Syntax highlighting
The syntax to use codefences is with backticks. If you provide the language after the first block of backticks, github will automatically put that in decent syntax highlighting. So, A simple code fence with AL code, can simply be done by:
````
```AL
procedure ALGuidelinesRock()
var
Customer: Record Customer;
begin
Customer.Get('10000');
Customer.Name := 'waldo';
Customer.Modify(true);
end;
```
````
Results in:
```AL
procedure ALGuidelinesRock()
var
Customer: Record Customer;
begin
Customer.Get('10000');
Customer.Name := 'waldo';
Customer.Modify(true);
end;
```
## Hugo Shortcodes
Since we're using "Hugo", we can use it's shortcode. Here is a reference: [https://gohugo.io/content-management/shortcodes/](https://gohugo.io/content-management/shortcodes/)
It basically means we are able to use easy notations to do cool things. Let's point out some useful shortcodes:
### Twitter
```
{{</* tweet user="waldo1001" id="1458787011024805892" */>}}
```
makes:
{{< tweet user="waldo1001" id="1458787011024805892" >}}
### YouTube
```
{{</* youtube QVOMCYitLEc */>}}
```
makes:
{{< youtube QVOMCYitLEc >}}
### Figure
```
{{</* figure src="http://www.waldo.be/wp-content/uploads/2021/11/business-central-logo.png" title="Business Central" */>}}
```
makes:
{{< figure src="http://www.waldo.be/wp-content/uploads/2021/11/business-central-logo.png" title="Business Central" >}}

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/)

View file

@ -0,0 +1,9 @@
+++
chapter = true
pre = "<b><i class='fas fa-clone'></i> </b>"
title = "Understanding the Approval Process"
weight = 100
+++
(coming soon)

View file

@ -0,0 +1,27 @@
+++
chapter = true
pre = "<b><i class='fas fa-clone'></i> </b>"
title = "Contributing"
weight = 100
+++
# Contributing
## Code of Conduct
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
## Steps to Contribute
* [Guide to Fork & PR](/contributing/forkandpr/)
* Templates:
- For [patterns](/contributing/templates/patterns/)
- For [guidelines](/contributing/templates/guidelines/)
* [Understanding the Approval Process](/contributing/theapprovalprocess/)
Here are some [tips and tricks in terms of working with MarkDown and Hugo](/contributing/formattingtips/).