Rough readme refactoring
This commit is contained in:
Alex Toader
Родитель
0fcbaadcd5
Коммит
86adcfd2ae
|
|
@ -0,0 +1,132 @@
|
|||
# Contributing
|
||||
|
||||
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.
|
||||
|
||||
https://github.com/twbs/bootstrap/blob/main/.github/CONTRIBUTING.md
|
||||
|
||||
If your problem or idea is not addressed yet, [please open a new issue](https://github.com/microsoft/AL/issues/new/choose).
|
||||
|
||||
**Note** that for issues related to:
|
||||
|
||||
- For **collaboration on extensions authored by Microsoft** as well as **event requests**, use [ALAppExtensions](https://github.com/Microsoft/ALAppExtensions).
|
||||
- Versions of Business Central that are in mainstream support you should use the [support channel](#support).
|
||||
- **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 issues related to **bugs on AL Language VSIX** in Visual Studio Code, use the current [GitHub repository](https://github.com/microsoft/al).
|
||||
- For suggestions and discussions on **code cop rules**, use the current [GitHub repo](https://github.com/microsoft/al).
|
||||
-
|
||||
# Contributing to VS Code
|
||||
|
||||
Welcome, and thank you for your interest in contributing to VS Code!
|
||||
|
||||
There are many ways in which you can contribute, beyond writing code. 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 ask away on [Stack Overflow](https://stackoverflow.com/questions/tagged/vscode) using the tag `vscode`.
|
||||
|
||||
The active community will be eager to assist you. Your well-worded question will serve as a resource to others searching for help.
|
||||
|
||||
## Providing Feedback
|
||||
|
||||
Your comments and feedback are welcome, and the development team is available via a handful of different channels.
|
||||
|
||||
See the [Feedback Channels](https://github.com/microsoft/vscode/wiki/Feedback-Channels) wiki page for details on how to share your thoughts.
|
||||
|
||||
## Reporting Issues
|
||||
|
||||
Have you identified a reproducible problem in VS Code? Have a feature request? We want to hear about it! Here's how you can make reporting your issue as effective as possible.
|
||||
|
||||
### Identify Where to Report
|
||||
|
||||
The VS Code project is distributed across multiple repositories. Try to file the issue against the correct repository. Check the list of [Related Projects](https://github.com/microsoft/vscode/wiki/Related-Projects) if you aren't sure which repo is correct.
|
||||
|
||||
Can you recreate the issue even after [disabling all extensions](https://code.visualstudio.com/docs/editor/extension-gallery#_disable-an-extension)? If you find the issue is caused by an extension you have installed, please file an issue on the extension's repo directly.
|
||||
|
||||
### Look For an Existing Issue
|
||||
|
||||
Before you create a new issue, please do a search in [open issues](https://github.com/microsoft/vscode/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/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc) feature requests.
|
||||
|
||||
If you find 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 or feature, create a new issue using the guidelines below.
|
||||
|
||||
### Writing Good Bug Reports and Feature Requests
|
||||
|
||||
File a single issue per problem and feature request. 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.
|
||||
|
||||
The built-in tool for reporting an issue, which you can access by using `Report Issue` in VS Code's Help menu, can help streamline this process by automatically providing the version of VS Code, all your installed extensions, and your system info. Additionally, the tool will search among existing issues to see if a similar issue already exists.
|
||||
|
||||
Please include the following with each issue:
|
||||
|
||||
* Version of VS Code
|
||||
|
||||
* Your operating system
|
||||
|
||||
* List of extensions that you have installed
|
||||
|
||||
* Reproducible steps (1... 2... 3...) that cause the issue
|
||||
|
||||
* What you expected to see, versus what you actually saw
|
||||
|
||||
* Images, animations, or a link to a video showing the issue occurring
|
||||
|
||||
* A 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.
|
||||
|
||||
* Errors from the Dev Tools Console (open from the menu: Help > Toggle Developer Tools)
|
||||
|
||||
### Final Checklist
|
||||
|
||||
Please remember to do the following:
|
||||
|
||||
* [ ] Search the issue repository to ensure your report is a new issue
|
||||
|
||||
* [ ] Recreate the issue after disabling all extensions
|
||||
|
||||
* [ ] Simplify your code around the issue to better isolate the problem
|
||||
|
||||
Don't feel bad if the developers can't reproduce the issue right away. They will simply ask for more information!
|
||||
|
||||
### Follow Your Issue
|
||||
|
||||
Once submitted, your report will go into the [issue tracking](https://github.com/microsoft/vscode/wiki/Issue-Tracking) workflow. Be sure to understand what will happen next, so you know what to expect, and how to continue to assist throughout the process.
|
||||
|
||||
## Automated Issue Management
|
||||
|
||||
We use GitHub Actions to help us manage issues. These Actions and their descriptions can be [viewed here](https://github.com/microsoft/vscode-github-triage-actions). Some examples of what these Actions do are:
|
||||
|
||||
* Automatically closes any issue marked `needs-more-info` if there has been no response in the past 7 days.
|
||||
* Automatically lock issues 45 days after they are closed.
|
||||
* Automatically implement the VS Code [feature request pipeline](https://github.com/microsoft/vscode/wiki/Issues-Triaging#managing-feature-requests).
|
||||
|
||||
If you believe the bot got something wrong, please open a new issue and let us know.
|
||||
|
||||
## Contributing Fixes
|
||||
|
||||
If you are interested in writing code to fix issues,
|
||||
please see [How to Contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute) in the wiki.
|
||||
|
||||
# Thank You!
|
||||
|
||||
Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.
|
||||
64
README.MD
64
README.MD
|
|
@ -1,41 +1,57 @@
|
|||
# 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 new 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 extension](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>
|
||||
## Support
|
||||
|
||||
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/
|
||||
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:
|
||||
|
||||
For documentation about extending Dynamics 365 Business Central, get started with some of our topics on Docs:
|
||||
- [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)
|
||||
|
||||
• [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)
|
||||
## Community
|
||||
|
||||
## 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://aka.ms/ready2go.
|
||||
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:
|
||||
|
||||
## FAQ
|
||||
Our answers to frequently asked questions can be found in our [Wiki](https://github.com/Microsoft/AL/wiki/Frequently-Asked-Questions).
|
||||
- [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)
|
||||
|
||||
## 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.
|
||||
## 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.
|
||||
|
||||
## License
|
||||
|
||||
Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
|
||||
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.
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче