Adding guidance for contributing (#30)
This commit is contained in:
Isaiah Williams
GitHub
Родитель
63be040d86
Коммит
e79d47fe7f
|
|
@ -0,0 +1,80 @@
|
|||
# Contributing to Security and Management Insights Connector
|
||||
|
||||
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. View the [Contributor License Agreement](https://cla.microsoft.com) for more details.
|
||||
|
||||
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 repos 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.
|
||||
|
||||
- [Code of Conduct](#code-of-conduct)
|
||||
- [Issues and Bugs](#finding-issues)
|
||||
- [Feature Requests](#requesting-features)
|
||||
- [Submission Guidelines](#submission-guidelines)
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
Help us keep this project open and inclusive. Please read and follow our [Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||||
|
||||
## Finding Issues
|
||||
|
||||
If you find a bug in the source code or a mistake in the documentation, you can help us by
|
||||
[submitting an issue](#submitting-an-issue) to the GitHub Repository. Even better, you can
|
||||
[submit a Pull Request](#submitting-a-pull-request) with a fix.
|
||||
|
||||
## Requesting Features
|
||||
|
||||
You can *request* a new feature by [submitting an issue](#submitting-an-issue) to the GitHub
|
||||
Repository. If you would like to *implement* a new feature, please submit an issue with
|
||||
a proposal for your work first, to be sure that we can use it.
|
||||
|
||||
**Small Features** can be crafted and directly [submitted as a Pull Request](#submitting-a-pull-request).
|
||||
|
||||
## Submission Guidelines
|
||||
|
||||
### Submitting an Issue
|
||||
|
||||
Before you submit an issue, search the archive, maybe your question was already answered.
|
||||
|
||||
If your issue appears to be a bug and hasn't been reported, open a new issue.
|
||||
Help us to maximize the effort we can spend fixing issues and add new
|
||||
features, by not reporting duplicate issues. Providing the following information will increase the
|
||||
chances of your issue being dealt with quickly:
|
||||
|
||||
- **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
|
||||
- **Version** - what version is affected (e.g. 0.1.2)
|
||||
- **Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you
|
||||
- **Browsers and Operating System** - is this a problem with all browsers?
|
||||
- **Reproduce the Error** - provide a live example or an unambiguous set of steps
|
||||
- **Related Issues** - has a similar issue been reported before?
|
||||
- **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
|
||||
causing the problem (line of code or commit)
|
||||
|
||||
You can file new issues by providing the above information at the [corresponding repository's issues link](https://github.com/microsoft/secmgmt-insights-connector/issues/new).
|
||||
|
||||
### Submitting a Pull Request
|
||||
|
||||
Before you submit your Pull Request (PR) consider the following guidelines:
|
||||
|
||||
- [Search the repository](https://github.com/microsoft/secmgmt-insights-connector/pulls) for an open or closed PR
|
||||
that relates to your submission. You don't want to duplicate effort.
|
||||
|
||||
- Make your changes in a new git fork:
|
||||
|
||||
- Commit your changes using a descriptive commit message
|
||||
- Push your fork to GitHub:
|
||||
- In GitHub, create a pull request
|
||||
- If we suggest changes then:
|
||||
- Make the required updates.
|
||||
- Rebase your fork and force push to your GitHub repository (this will update your Pull Request):
|
||||
|
||||
```shell
|
||||
git rebase master -i
|
||||
git push -f
|
||||
```
|
||||
|
||||
That is it! Thank you for your contribution!
|
||||
|
|
@ -6,10 +6,19 @@ MinimumVisualStudioVersion = 10.0.40219.1
|
|||
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{406D48B9-EC36-49F3-A89F-761926CB5AA1}"
|
||||
EndProject
|
||||
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{1A657FB5-C08A-42EC-9966-C0605A99684C}"
|
||||
ProjectSection(SolutionItems) = preProject
|
||||
azuredeploy.json = azuredeploy.json
|
||||
azuredeploy.parameters.json = azuredeploy.parameters.json
|
||||
CODE_OF_CONDUCT.md = CODE_OF_CONDUCT.md
|
||||
CONTRIBUTING.md = CONTRIBUTING.md
|
||||
LICENSE = LICENSE
|
||||
README.md = README.md
|
||||
SECURITY.md = SECURITY.md
|
||||
EndProjectSection
|
||||
EndProject
|
||||
Project("{4DF76451-A46A-4C0B-BE03-459FAAFA07E6}") = "SecMgmtInsights", "src\SecMgmtInsights\SecMgmtInsights.mproj", "{A7D11851-1E6A-4C9E-9E63-D007A50CD38B}"
|
||||
EndProject
|
||||
Project("{4DF76451-A46A-4C0B-BE03-459FAAFA07E6}") = "SecMgmtInsights.PowerShell", "src\SecMgmtInsights.PowerShell\SecMgmtInsights.PowerShell.mproj", "{B35ED3A4-09B3-48FC-BBCE-4A1FD36A0571}"
|
||||
Project("{4DF76451-A46A-4C0B-BE03-459FAAFA07E6}") = "SecMgmtInsights.PowerShell", "src\SecMgmtInsights.PowerShell\SecMgmtInsights.PowerShell.mproj", "{ECBF8DD8-8465-4246-9878-515606889DD7}"
|
||||
EndProject
|
||||
Global
|
||||
GlobalSection(SolutionConfigurationPlatforms) = preSolution
|
||||
|
|
@ -21,17 +30,17 @@ Global
|
|||
{A7D11851-1E6A-4C9E-9E63-D007A50CD38B}.Debug|x86.Build.0 = Debug|x86
|
||||
{A7D11851-1E6A-4C9E-9E63-D007A50CD38B}.Release|x86.ActiveCfg = Release|x86
|
||||
{A7D11851-1E6A-4C9E-9E63-D007A50CD38B}.Release|x86.Build.0 = Release|x86
|
||||
{B35ED3A4-09B3-48FC-BBCE-4A1FD36A0571}.Debug|x86.ActiveCfg = Debug|x86
|
||||
{B35ED3A4-09B3-48FC-BBCE-4A1FD36A0571}.Debug|x86.Build.0 = Debug|x86
|
||||
{B35ED3A4-09B3-48FC-BBCE-4A1FD36A0571}.Release|x86.ActiveCfg = Release|x86
|
||||
{B35ED3A4-09B3-48FC-BBCE-4A1FD36A0571}.Release|x86.Build.0 = Release|x86
|
||||
{ECBF8DD8-8465-4246-9878-515606889DD7}.Debug|x86.ActiveCfg = Debug|x86
|
||||
{ECBF8DD8-8465-4246-9878-515606889DD7}.Debug|x86.Build.0 = Debug|x86
|
||||
{ECBF8DD8-8465-4246-9878-515606889DD7}.Release|x86.ActiveCfg = Release|x86
|
||||
{ECBF8DD8-8465-4246-9878-515606889DD7}.Release|x86.Build.0 = Release|x86
|
||||
EndGlobalSection
|
||||
GlobalSection(SolutionProperties) = preSolution
|
||||
HideSolutionNode = FALSE
|
||||
EndGlobalSection
|
||||
GlobalSection(NestedProjects) = preSolution
|
||||
{A7D11851-1E6A-4C9E-9E63-D007A50CD38B} = {406D48B9-EC36-49F3-A89F-761926CB5AA1}
|
||||
{B35ED3A4-09B3-48FC-BBCE-4A1FD36A0571} = {406D48B9-EC36-49F3-A89F-761926CB5AA1}
|
||||
{ECBF8DD8-8465-4246-9878-515606889DD7} = {406D48B9-EC36-49F3-A89F-761926CB5AA1}
|
||||
EndGlobalSection
|
||||
GlobalSection(ExtensibilityGlobals) = postSolution
|
||||
SolutionGuid = {826393DF-0200-4655-BBC5-16A88740CF8B}
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче