From ebde50d8125d6b083bfe76fb55c88fd242f02eb7 Mon Sep 17 00:00:00 2001 From: Alex Toader Date: Fri, 19 Mar 2021 10:46:53 +0100 Subject: [PATCH 1/2] Factor feedback from review --- .../al-developer-experience-bug.md | 3 ++ CONTRIBUTING.md | 42 ++++++++++++++----- README.MD | 11 ++--- 3 files changed, 40 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/al-developer-experience-bug.md b/.github/ISSUE_TEMPLATE/al-developer-experience-bug.md index 8c0f046..18cf2c6 100644 --- a/.github/ISSUE_TEMPLATE/al-developer-experience-bug.md +++ b/.github/ISSUE_TEMPLATE/al-developer-experience-bug.md @@ -13,6 +13,9 @@ Read the contributing https://github.com/microsoft/AL/blob/master/CONTRIBUTING.M Please follow this template in order for our developers to investigate your issue efficiently. Do not edit or remove the titles; e.g. "Descibe the bug". + +Use the latest version of the AL language extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=ms-dynamics-smb.al) or shipped as part of the [AL Developer Preview builds](README.md#al-developer-preview-builds) for Dynamics 365 Business Central. + --> Please include the following with each issue: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ce2ed7..fefabb8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,9 @@ Have a question? Rather than opening an issue, please use one of the following r - [Business Central Community](https://community.dynamics.com/business/f/758) - [mibuso forum](https://forum.mibuso.com/categories/nav-three-tier) -- [Dynamics User Group](https://dynamicsuser.net/nav/f/developers) +- [Dynamics User Group](https://dynamicsuser.net/nav/f/developers) +- [Yammer groups for partners](https://aka.ms/BCYammer) +- [Monthly themed Office Hours](https://aka.ms/BCOfficehours) The community will be eager to assist you and your well-worded question will serve as a resource to others searching for help. @@ -20,19 +22,33 @@ Have you identified a reproducible problem in the AL compiler or developer tools The Dynamics 365 Business Central team accepts feedback through multiple channels and repositories. Try to file the issue through the correct channel to ensure that your issue is addressed effectively and efficiently. -- For bugs in the latest version of the AL Language extension for Visual Studio Code or any of the static analysis tools that accompany the AL Language extension, use the current [GitHub repository](https://github.com/microsoft/al). You should always use the latest version of the AL Language extension when targeting any version of Business Central. If you are targeting Dynamics NAV 2018 or older, please use the [support channel](#support). -- For new features in AL/Visual Studio Code language and tools, as well as Business Central in general, use [Business Central Ideas](https://aka.ms/bcideas). This will allow other members of the community to vote on your idea and will allow us to prioritize based accordingly. -- For suggestions for new static analysis rules or improvements to existing static analysis rules, use [Business Central Ideas](https://aka.ms/bcideas). -- For issues related to the extensibility of applications authored by Microsoft, such as the `System Application` or the `Base Application`, use the [ALAppExtensions](https://github.com/Microsoft/ALAppExtensions) repository. -- For issues concerning versions of Business Central that are in mainstream support you should use the [support channel](#support). +#### **Security vulnerabilities** +Please follow the instructions in this [document](SECURITY.MD) to ensure that the issue is handled with the highest priority. + +#### **Bugs** +For bugs in the latest version of the AL Language extension for Visual Studio Code or any of the static analysis tools that accompany the AL Language extension, use the current [GitHub repository](https://github.com/microsoft/al). You should always use the latest version of the AL Language extension when targeting any version of Business Central. + +If you are targeting Dynamics NAV 2018 or older, you must use the AL extension provided in the DVD and use the [support channel](#support) to report issues. + +For issues concerning versions of Business Central that are in mainstream support you should use the [support channel](#support). + +#### **Extensibility of first-party AL applications** +For issues related to the extensibility of applications authored by Microsoft, such as the `System Application` or the `Base Application`, use the [ALAppExtensions](https://github.com/Microsoft/ALAppExtensions) repository. + +#### **Feature requests and suggestions** +For new features in AL/Visual Studio Code language and tools, as well as Business Central in general, use [Business Central Ideas](https://aka.ms/bcideas). + +For suggestions for new static analysis rules or improvements to existing static analysis rules, use [Business Central Ideas](https://aka.ms/bcideas). + +Posting your suggestion on [Business Central Ideas](https://aka.ms/bcideas) will allow other members of the community to vote on your idea and will allow us to prioritize based accordingly. ### Look for an existing issue -Before you create a new issue, please do a search in [open issues](https://github.com/microsoft/AL/issues) to see if the issue or feature request has already been filed. +Before you create a new issue, please do a search in [open issues](https://github.com/microsoft/AL/issues) to see if the issue or feature request has already been filed, and add to that instead. -Be sure to scan through the [most popular](https://github.com/microsoft/AL/issues?q=is%3Aopen+is%3Aissue+sort%3Areactions-%2B1-desc+) issues. +Be sure to scan through the [most popular](https://github.com/microsoft/AL/issues?q=is%3Aopen+is%3Aissue+sort%3Areactions-%2B1-desc+) issues, and vote on/add to existing issue if applicable. -If you find that your issue already exists, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment: +If you find that your issue already exists in this repository, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment: - 👍 - upvote - 👎 - downvote @@ -43,6 +59,10 @@ If you cannot find an existing issue that describes your bug, create a new issue File a single issue per problem. Do not enumerate multiple bugs or feature requests in the same issue. +Use the latest version of the AL language extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=ms-dynamics-smb.al) or shipped as part of the [AL Developer Preview builds](README.md#al-developer-preview-builds) for Dynamics 365 Business Central. + +Switch off all extensions except the AL Language extension. + Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes. The more information you can provide, the more likely someone will be successful at reproducing the issue and finding a fix. @@ -71,7 +91,7 @@ A clear and concise description of what happened accompanied by images, animatio - AL Language. Go to Visual Studio Code → Extensions panel → AL Language - Visual Studio Code: Go to Visual Studio Code → Help → About -- Business Central. In the client search for: System Information +- Business Central. In the web client, go to Help → Help and Support → Troubleshooting - List of extensions that you have installed ### Final checklist @@ -86,7 +106,7 @@ Please remember to do the following: ### Follow your issue -Once submitted, your report will go into the [issue tracking](https://github.com/microsoft/AL/wiki/Issue-Tracking) workflow. Be sure to understand what will happen next, so that you know what to expect, and how to continue to assist throughout the process. +Once submitted, your issue will through the [issue tracking](https://github.com/microsoft/AL/wiki/Issue-Tracking) workflow. Please read the document to understand what will happen next, so that you know what to expect, and how to continue to assist throughout the process. ## Support diff --git a/README.MD b/README.MD index 43d8882..a5290cb 100644 --- a/README.MD +++ b/README.MD @@ -11,7 +11,7 @@ For documentation about using the [AL Language](https://marketplace.visualstudio • [Building Your First Sample Extension](https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/developer/devenv-extension-example) • [Developer Reference](https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/developer/devenv-reference-overview) -## Bugs and Feature Requests +## Bugs and feature requests If you have encountered a bug or you have a feature request, please first read the [contributing guidelines](CONTRIBUTING.md) and then search for existing and closed issues. @@ -24,22 +24,23 @@ See the [triage process](https://github.com/Microsoft/AL/wiki/Triage-Process) do Our answers to frequently asked questions can be found in our [FAQ](https://github.com/Microsoft/AL/wiki/Frequently-Asked-Questions). To get help from community members please use one of the following resources: - [Business Central Community](https://community.dynamics.com/business/f/758) -- [mibuso forum](https://forum.mibuso.com/categories/nav-three-tier) - [Dynamics User Group](https://dynamicsuser.net/nav/f/developers) +- [Yammer groups for partners](https://aka.ms/BCYammer) +- [mibuso forum](https://forum.mibuso.com/categories/nav-three-tier) -## Related Projects +## Related projects The following repositories can provide additional resources depending on the issues that you are facing: - [Microsoft AL application foundation modules and application add-ons for Microsoft Dynamics 365 Business Central](https://github.com/microsoft/ALAppExtensions) - [Microsoft Dynamics 365 Business Central Docs](https://github.com/MicrosoftDocs/dynamics365smb-devitpro-pb) -- [Official Microsoft repository for NavContainerHelper, a PowerShell module, which makes it easier to work with Nav Containers on Docker.](https://github.com/Microsoft/navcontainerhelper) +- [Official Microsoft repository for BcContainerHelper, a PowerShell module, which makes it easier to work with BC Containers on Docker.](https://github.com/Microsoft/navcontainerhelper) ## Contributing Please read through our [contributing guidelines](CONTRIBUTING.md). -## Code of Conduct +## Code of conduct This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. From ce239ce40f776ba49cc40c681337538583932d35 Mon Sep 17 00:00:00 2001 From: Alex Toader Date: Fri, 19 Mar 2021 12:15:15 +0100 Subject: [PATCH 2/2] More feedback --- .github/ISSUE_TEMPLATE/al-developer-experience-bug.md | 4 +++- CONTRIBUTING.md | 6 +++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/al-developer-experience-bug.md b/.github/ISSUE_TEMPLATE/al-developer-experience-bug.md index 18cf2c6..048e5fa 100644 --- a/.github/ISSUE_TEMPLATE/al-developer-experience-bug.md +++ b/.github/ISSUE_TEMPLATE/al-developer-experience-bug.md @@ -12,10 +12,12 @@ Read the contributing https://github.com/microsoft/AL/blob/master/CONTRIBUTING.M Please follow this template in order for our developers to investigate your issue efficiently. -Do not edit or remove the titles; e.g. "Descibe the bug". +Do not edit or remove the titles; e.g. "Describe the bug". Use the latest version of the AL language extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=ms-dynamics-smb.al) or shipped as part of the [AL Developer Preview builds](README.md#al-developer-preview-builds) for Dynamics 365 Business Central. +Disable all extensions except the AL Language extension. + --> Please include the following with each issue: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fefabb8..3c26570 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,7 +26,7 @@ The Dynamics 365 Business Central team accepts feedback through multiple channel Please follow the instructions in this [document](SECURITY.MD) to ensure that the issue is handled with the highest priority. #### **Bugs** -For bugs in the latest version of the AL Language extension for Visual Studio Code or any of the static analysis tools that accompany the AL Language extension, use the current [GitHub repository](https://github.com/microsoft/al). You should always use the latest version of the AL Language extension when targeting any version of Business Central. +For bugs in the latest version of the AL language extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=ms-dynamics-smb.al) or any of the static analysis tools that accompany the AL Language extension, use the current [GitHub repository](https://github.com/microsoft/al). You should always use the latest version of the AL Language extension when targeting any version of Business Central. If you are targeting Dynamics NAV 2018 or older, you must use the AL extension provided in the DVD and use the [support channel](#support) to report issues. @@ -44,7 +44,7 @@ Posting your suggestion on [Business Central Ideas](https://aka.ms/bcideas) will ### Look for an existing issue -Before you create a new issue, please do a search in [open issues](https://github.com/microsoft/AL/issues) to see if the issue or feature request has already been filed, and add to that instead. +Before you create a new issue, please do a search in [open issues](https://github.com/microsoft/AL/issues) to see if the issue has already been filed. Be sure to scan through the [most popular](https://github.com/microsoft/AL/issues?q=is%3Aopen+is%3Aissue+sort%3Areactions-%2B1-desc+) issues, and vote on/add to existing issue if applicable. @@ -61,7 +61,7 @@ File a single issue per problem. Do not enumerate multiple bugs or feature reque Use the latest version of the AL language extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=ms-dynamics-smb.al) or shipped as part of the [AL Developer Preview builds](README.md#al-developer-preview-builds) for Dynamics 365 Business Central. -Switch off all extensions except the AL Language extension. +Disable all extensions except the AL Language extension. Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes.