Merge pull request #6542 from microsoft/features/updateGuidance
Update guidance for creating issues on GitHub
This commit is contained in:
Alexandru Toader
GitHub
Коммит
ee121ad1de
|
|
@ -0,0 +1,111 @@
|
|||
# Contributing
|
||||
|
||||
Welcome, and thank you for your interest in contributing to the AL developer tools! The goal of this document is to provide a high-level overview of how you can get involved.
|
||||
|
||||
## Asking questions
|
||||
|
||||
Have a question? Rather than opening an issue, 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)
|
||||
|
||||
The community will be eager to assist you and your well-worded question will serve as a resource to others searching for help.
|
||||
|
||||
## Reporting issues
|
||||
|
||||
Have you identified a reproducible problem in the AL compiler or developer tools? Here's how you can make reporting your issue as effective as possible.
|
||||
|
||||
### Identify where to report
|
||||
|
||||
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 issues related to 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 extensions authored by Microsoft, such as the `System Application` or the `Base Application` as well as event requests, 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).
|
||||
|
||||
### 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.
|
||||
|
||||
Be sure to scan through the [most popular](https://github.com/microsoft/AL/issues?q=is%3Aopen+is%3Aissue+sort%3Areactions-%2B1-desc+) issues.
|
||||
|
||||
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:
|
||||
|
||||
- 👍 - upvote
|
||||
- 👎 - downvote
|
||||
|
||||
If you cannot find an existing issue that describes your bug, create a new issue using the guidelines below.
|
||||
|
||||
### Writing good bug reports
|
||||
|
||||
File a single issue per problem. Do not enumerate multiple bugs or feature requests in the same issue.
|
||||
|
||||
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.
|
||||
|
||||
Please include the following with each issue:
|
||||
|
||||
**1. Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**2. To Reproduce**
|
||||
Steps and to reproduce the behavior:
|
||||
|
||||
1. Go to '...'
|
||||
|
||||
``` AL code snippet that demonstrates the issue or a link to a code repository the developers can easily pull down to recreate the issue locally ```
|
||||
|
||||
**Note:** Because the developers need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient.
|
||||
|
||||
**3. Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**4. Actual behavior**
|
||||
A clear and concise description of what happened accompanied by images, animations, or a link to a video showing the issue occurring.
|
||||
|
||||
**5. Versions:**
|
||||
|
||||
- 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
|
||||
- List of extensions that you have installed
|
||||
|
||||
### Final checklist
|
||||
|
||||
Please remember to do the following:
|
||||
|
||||
* [ ] Search the issue repository to ensure you are reporting a new issue
|
||||
|
||||
* [ ] Reproduce the issue after switching off all extensions except the AL Language extension
|
||||
|
||||
* [ ] Simplify your code around the issue to better isolate the problem
|
||||
|
||||
### 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.
|
||||
|
||||
## Support
|
||||
|
||||
If you have encountered an issue in a version of the AL compiler and developer tools that is in mainstream support, or in the application, platform, or another component of Dynamics 365 Business Central, please read the following articles on how to get support for the Dynamics 365 Business Central product:
|
||||
|
||||
- [Technical Support for Dynamics 365 Business Central](https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/technical-support)
|
||||
- [Managing Technical Support](https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/administration/manage-technical-support)
|
||||
|
||||
## Contributor License Agreement
|
||||
|
||||
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.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., label, comment). Simply follow the
|
||||
instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
|
||||
|
||||
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.
|
||||
55
README.MD
55
README.MD
|
|
@ -1,41 +1,52 @@
|
|||
# Visual Studio Code AL Language extension for Dynamics 365 Business Central
|
||||
|
||||
---
|
||||
|
||||
## Welcome
|
||||
The main purpose of this repository is to track issues regarding the AL compiler and the Developer Tools for the latest developer preview environment for Dynamics 365 Business Central. In addition, you will find code samples to help you get started writing extensions in AL and get familiar with the new tools. Your feedback is very welcome; submit it directly in this repository.
|
||||
|
||||
<!--
|
||||
**Note** that for issues related to ***versions of Business Central that are in mainstream support you should use the support channel*** - see [this FAQ entry](https://github.com/Microsoft/AL/wiki/Frequently-Asked-Questions#i-found-an-issue-in-a-version-of-the-product-that-is-not-the-latest-what-do-i-do). -->
|
||||
The main purpose of this repository is to track issues regarding the latest version of the AL compiler and developer tools available in the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=ms-dynamics-smb.al) or as part of the [AL Developer Preview builds](#al-developer-preview-builds) for Dynamics 365 Business Central. In addition, you will find code samples to help you get started writing extensions in AL and get familiar with the tools.
|
||||
|
||||
**Note** that for issues related to:
|
||||
## Documentation
|
||||
|
||||
- **versions of Business Central that are in mainstream support you should use the support channel** - see [this FAQ entry](https://github.com/Microsoft/AL/wiki/requently-Asked-Questions#i-found-an-issue-in-a-version-of-the-product-that-is-not-the-latest-what-do-i-do).
|
||||
For documentation about using the [AL Language](https://marketplace.visualstudio.com/items?itemName=ms-dynamics-smb.al) to extend Dynamics 365 Business Central, read some of our topics on [Microsoft Dynamics 365 Business Central docs](https://docs.microsoft.com/en-us/dynamics365/business-central/):
|
||||
• [Getting Started](https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/developer/devenv-get-started)
|
||||
• [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)
|
||||
|
||||
- For issues related to **bugs on AL Language VSIX** in Visual Studio Code (aka ModernDev), use the current [GitHub repo](https://github.com/microsoft/al).
|
||||
## Bugs and Feature Requests
|
||||
|
||||
- For suggestions and discussions on **code cop rules**, use the current [GitHub repo](https://github.com/microsoft/al).
|
||||
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.
|
||||
|
||||
- For suggestions on **new features** in AL/Visual Studio Code language and tools, as well as Business Central in general, use [Ideas](https://aka.ms/bcideas) to allow voting, as we get more requests than we have time and need to prioritize by demand/impact.
|
||||
Bugs pertaining to the AL compiler and the developer tools for the latest version can be filed in this repository. We will respond to these issues on a best-effort basis.
|
||||
|
||||
- For **collaboration on system and base applications** as well as **event requests**, use [ALAppExtensions](https://github.com/Microsoft/ALAppExtensions).
|
||||
See the [triage process](https://github.com/Microsoft/AL/wiki/Triage-Process) document for more information on how we handle incoming requests.
|
||||
|
||||
<br>
|
||||
## Community
|
||||
|
||||
Please read this blog post to get familiar with how Developer Preview releases relate to other versions of Business Central:
|
||||
https://blogs.msdn.microsoft.com/nav/2018/05/03/al-developer-previews-multiple-releases-and-github/
|
||||
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:
|
||||
|
||||
For documentation about extending Dynamics 365 Business Central, get started with some of our topics on Docs:
|
||||
- [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)
|
||||
|
||||
• [Getting Started](https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/developer/devenv-get-started)
|
||||
• [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)
|
||||
## 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)
|
||||
|
||||
## Contributing
|
||||
|
||||
Please read through our [contributing guidelines](CONTRIBUTING.md).
|
||||
|
||||
## 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.
|
||||
|
||||
## AL Developer Preview builds
|
||||
To get access to the AL Developer Preview builds you need to be part of the Ready2Go program. Detailed instructions can be found at https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/developer/readiness/get-started.
|
||||
|
||||
## FAQ
|
||||
Our answers to frequently asked questions can be found in our [Wiki](https://github.com/Microsoft/AL/wiki/Frequently-Asked-Questions).
|
||||
## License
|
||||
Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
|
||||
## Notice
|
||||
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__ with any additional questions or comments.
|
||||
Licensed under the [MIT](LICENSE.txt) license.
|
||||
|
|
|
|||
20
SECURITY.MD
20
SECURITY.MD
|
|
@ -1,4 +1,4 @@
|
|||
## Security
|
||||
# Security
|
||||
|
||||
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [many more](https://opensource.microsoft.com/).
|
||||
|
||||
|
|
@ -8,20 +8,20 @@ If you believe you have found a security vulnerability in any Microsoft-owned re
|
|||
|
||||
**Please do not report security vulnerabilities through public GitHub issues.** Instead, please report them to the Microsoft Security Response Center at [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://technet.microsoft.com/en-us/security/dn606155).
|
||||
|
||||
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
|
||||
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
|
||||
|
||||
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
|
||||
|
||||
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
|
||||
* Full paths of source file(s) related to the manifestation of the issue
|
||||
* The location of the affected source code (tag/branch/commit or direct URL)
|
||||
* Any special configuration required to reproduce the issue
|
||||
* Step-by-step instructions to reproduce the issue
|
||||
* Proof-of-concept or exploit code (if possible)
|
||||
* Impact of the issue, including how an attacker might exploit the issue
|
||||
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
|
||||
* Full paths of source file(s) related to the manifestation of the issue
|
||||
* The location of the affected source code (tag/branch/commit or direct URL)
|
||||
* Any special configuration required to reproduce the issue
|
||||
* Step-by-step instructions to reproduce the issue
|
||||
* Proof-of-concept or exploit code (if possible)
|
||||
* Impact of the issue, including how an attacker might exploit the issue
|
||||
|
||||
This information will help us triage your report more quickly.
|
||||
|
||||
|
||||
## Preferred Languages
|
||||
|
||||
We prefer all communications to be in English.
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче