forked from Azure/azure-sdk-for-net
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from Azure/master
Merge from master
- Loading branch information
Showing
8,401 changed files
with
1,084,978 additions
and
641,708 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,185 @@ | ||
# editorconfig.org | ||
|
||
# top-most EditorConfig file | ||
root = true | ||
|
||
# Default settings: | ||
# A newline ending every file | ||
# Use 4 spaces as indentation | ||
[sdk/*/Azure.*/**] | ||
insert_final_newline = true | ||
indent_style = space | ||
indent_size = 4 | ||
|
||
# C# files | ||
[sdk/*/Azure.*/**.cs] | ||
# New line preferences | ||
csharp_new_line_before_open_brace = all # vs-default: any | ||
csharp_new_line_before_else = true # vs-default: true | ||
csharp_new_line_before_catch = true # vs-default: true | ||
csharp_new_line_before_finally = true # vs-default: true | ||
csharp_new_line_before_members_in_object_initializers = true # vs-default: true | ||
csharp_new_line_before_members_in_anonymous_types = true # vs-default: true | ||
csharp_new_line_between_query_expression_clauses = true # vs-default: true | ||
|
||
# Indentation preferences | ||
csharp_indent_block_contents = true # vs-default: true | ||
csharp_indent_braces = false # vs-default: false | ||
csharp_indent_case_contents = true # vs-default: true | ||
csharp_indent_case_contents_when_block = true | ||
csharp_indent_switch_labels = true # vs-default: true | ||
csharp_indent_labels = one_less_than_current # vs-default: one_less_than_current | ||
|
||
# Modifier preferences | ||
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion | ||
|
||
# avoid this. unless absolutely necessary | ||
dotnet_style_qualification_for_field = false:suggestion # vs-default: false:none | ||
dotnet_style_qualification_for_property = false:suggestion # vs-default: false:none | ||
dotnet_style_qualification_for_method = false:suggestion # vs-default: false:none | ||
dotnet_style_qualification_for_event = false:suggestion # vs-default: false:none | ||
|
||
# only use var when it's obvious what the variable type is | ||
csharp_style_var_for_built_in_types = false:none # vs-default: true:none | ||
csharp_style_var_when_type_is_apparent = false:none # vs-default: true:none | ||
csharp_style_var_elsewhere = false:suggestion # vs-default: true:none | ||
|
||
# use language keywords instead of BCL types | ||
dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion # vs-default: true:none | ||
dotnet_style_predefined_type_for_member_access = true:suggestion # vs-default: true:none | ||
|
||
# name all constant fields using PascalCase | ||
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion | ||
dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields | ||
dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style | ||
|
||
dotnet_naming_symbols.constant_fields.applicable_kinds = field | ||
dotnet_naming_symbols.constant_fields.required_modifiers = const | ||
|
||
dotnet_naming_style.pascal_case_style.capitalization = pascal_case | ||
|
||
# static fields should have s_ prefix | ||
dotnet_naming_rule.static_fields_should_have_prefix.severity = suggestion | ||
dotnet_naming_rule.static_fields_should_have_prefix.symbols = static_fields | ||
dotnet_naming_rule.static_fields_should_have_prefix.style = static_prefix_style | ||
|
||
dotnet_naming_symbols.static_fields.applicable_kinds = field | ||
dotnet_naming_symbols.static_fields.required_modifiers = static | ||
dotnet_naming_symbols.static_fields.applicable_accessibilities = private, internal, private_protected | ||
dotnet_naming_style.static_prefix_style.required_prefix = s_ | ||
dotnet_naming_style.static_prefix_style.capitalization = camel_case | ||
|
||
# internal and private fields should be _camelCase | ||
dotnet_naming_rule.camel_case_for_private_internal_fields.severity = suggestion | ||
dotnet_naming_rule.camel_case_for_private_internal_fields.symbols = private_internal_fields | ||
dotnet_naming_rule.camel_case_for_private_internal_fields.style = camel_case_underscore_style | ||
|
||
dotnet_naming_symbols.private_internal_fields.applicable_kinds = field | ||
dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal | ||
|
||
dotnet_naming_style.camel_case_underscore_style.required_prefix = _ | ||
dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case | ||
|
||
# Code style defaults | ||
csharp_using_directive_placement = outside_namespace:suggestion | ||
dotnet_sort_system_directives_first = true # vs-default: true | ||
csharp_prefer_braces = true:refactoring | ||
csharp_preserve_single_line_blocks = true # vs-default: true | ||
csharp_preserve_single_line_statements = false # vs-default: true | ||
csharp_prefer_static_local_function = true:suggestion | ||
csharp_prefer_simple_using_statement = false:none | ||
csharp_style_prefer_switch_expression = true:suggestion | ||
|
||
# Code quality | ||
dotnet_style_readonly_field = true:suggestion | ||
dotnet_code_quality_unused_parameters = non_public:suggestion | ||
|
||
# Expression-level preferences | ||
dotnet_style_object_initializer = true:suggestion # vs-default: true:suggestion | ||
dotnet_style_collection_initializer = true:suggestion # vs-default: true:suggestion | ||
dotnet_style_explicit_tuple_names = true:suggestion # vs-default: true:suggestion | ||
dotnet_style_coalesce_expression = true:suggestion # vs-default: true:suggestion | ||
dotnet_style_null_propagation = true:suggestion # vs-default: true:suggestion | ||
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion | ||
dotnet_style_prefer_inferred_tuple_names = true:suggestion | ||
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion | ||
dotnet_style_prefer_auto_properties = true:suggestion | ||
dotnet_style_prefer_conditional_expression_over_assignment = true:refactoring | ||
dotnet_style_prefer_conditional_expression_over_return = true:refactoring | ||
csharp_prefer_simple_default_expression = true:suggestion | ||
|
||
# Expression-bodied members | ||
csharp_style_expression_bodied_methods = false:none # vs-default: false:none | ||
csharp_style_expression_bodied_constructors = false:none # vs-default: false:none | ||
csharp_style_expression_bodied_operators = false:none # vs-default: false:none | ||
csharp_style_expression_bodied_properties = true:none # vs-default: true:none | ||
csharp_style_expression_bodied_indexers = true:none # vs-default: true:none | ||
csharp_style_expression_bodied_accessors = true:none # vs-default: true:none | ||
csharp_style_expression_bodied_lambdas = true:refactoring | ||
csharp_style_expression_bodied_local_functions = true:refactoring | ||
|
||
# Pattern matching | ||
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion # vs-default: true:suggestion | ||
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion # vs-default: true:suggestion | ||
csharp_style_inlined_variable_declaration = true:suggestion # vs-default: true:suggestion | ||
|
||
# Null checking preferences | ||
csharp_style_throw_expression = true:suggestion # vs-default: true:suggestion | ||
csharp_style_conditional_delegate_call = true:suggestion # vs-default: true:suggestion | ||
|
||
# Other features | ||
csharp_style_prefer_index_operator = false:none | ||
csharp_style_prefer_range_operator = false:none | ||
csharp_style_pattern_local_over_anonymous_function = false:none | ||
|
||
# Space preferences | ||
csharp_space_after_cast = false # vs-default: false | ||
csharp_space_after_colon_in_inheritance_clause = true # vs-default: true | ||
csharp_space_after_comma = true # vs-default: true | ||
csharp_space_after_dot = false # vs-default: false | ||
csharp_space_after_keywords_in_control_flow_statements = true # vs-default: true | ||
csharp_space_after_semicolon_in_for_statement = true # vs-default: true | ||
csharp_space_around_binary_operators = before_and_after # vs-default: before_and_after | ||
csharp_space_around_declaration_statements = do_not_ignore # vs-default: false | ||
csharp_space_before_colon_in_inheritance_clause = true # vs-default: true | ||
csharp_space_before_comma = false # vs-default: false | ||
csharp_space_before_dot = false # vs-default: false | ||
csharp_space_before_open_square_brackets = false # vs-default: false | ||
csharp_space_before_semicolon_in_for_statement = false # vs-default: false | ||
csharp_space_between_empty_square_brackets = false # vs-default: false | ||
csharp_space_between_method_call_empty_parameter_list_parentheses = false # vs-default: false | ||
csharp_space_between_method_call_name_and_opening_parenthesis = false # vs-default: false | ||
csharp_space_between_method_call_parameter_list_parentheses = false # vs-default: false | ||
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false # vs-default: false | ||
csharp_space_between_method_declaration_name_and_open_parenthesis = false # vs-default: false | ||
csharp_space_between_method_declaration_parameter_list_parentheses = false # vs-default: false | ||
csharp_space_between_parentheses = false # vs-default: false | ||
csharp_space_between_square_brackets = false # vs-default: false | ||
|
||
# Require accessibility modifiers | ||
dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion # vs-default: for_non_interface_members:none | ||
|
||
# Analyzers | ||
dotnet_code_quality.ca1802.api_surface = private, internal | ||
|
||
# Xml project files | ||
[*.{csproj,vcxproj,vcxproj.filters,proj,nativeproj,locproj}] | ||
indent_size = 2 | ||
|
||
# Xml build files | ||
[*.builds] | ||
indent_size = 2 | ||
|
||
# Xml files | ||
[*.{xml,stylecop,resx,ruleset}] | ||
indent_size = 2 | ||
|
||
# Xml config files | ||
[*.{props,targets,config,nuspec}] | ||
indent_size = 2 | ||
|
||
# Shell scripts | ||
[*.sh] | ||
end_of_line = lf | ||
[*.{cmd, bat}] | ||
end_of_line = crlf |
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,29 @@ | ||
# Contributing | ||
|
||
| Component | Build Status | | ||
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| Management Libraries | [![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/net/net%20-%20mgmt%20-%20ci?branchName=master)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=529&branchName=master) | | ||
| Client Libraries | [![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/41?branchName=master)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=41&branchName=master) | | ||
| Component | Build Status | | ||
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| Management Libraries | [![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/net/net%20-%20mgmt%20-%20ci?branchName=master)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=529&branchName=master) | | ||
| Client Libraries | [![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/net/net%20-%20client%20-%20ci?branchName=master)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=290&branchName=master) | | ||
|
||
# Prerequisites: | ||
|
||
Install VS 2019 (Professional or higher) and make sure you have the latest updates (https://www.visualstudio.com/). | ||
- Install VS 2019 (Community or higher) and make sure you have the latest updates (https://www.visualstudio.com/). | ||
- Need at least .NET Framework 4.6.1 and 4.7 development tools | ||
- Install the **.NET Core cross-platform development** workloads in VisualStudio | ||
- Install **.NET Core 3.0.100 SDK ** or higher for your specific platform. (https://dotnet.microsoft.com/download/dotnet-core/3.0) | ||
- Install the latest version of git (https://git-scm.com/downloads) | ||
|
||
## GENERAL THINGS TO KNOW: | ||
|
||
**Client Libraries** are sdks used to interact with azure resources at application run time while **Management Libraries** are those used to manage (create/modify/delete) Azure resources. | ||
<br/><br/> | ||
|
||
**Build Repo :** To build all Client and Management libraries together. Invoke `dotnet build build.proj` from the root of the repo.<br/>To scope to a single service supply a scope property e.g. `dotnet build build.proj /p:Scope=servicebus`. This will build both client and management projects in the specified service. If using msbuild you must run restore first. See below for how to build the [client](#client-libraries) or [management](#management-libraries) libraries independently. | ||
|
||
**Path Length :** To account for the **260 characters Path Length Limit** encountered on windows OS, file paths within the repo is keep below 210 characters. This gives you a runway of 49 characters as clone path for your repo. Paths longer that 260 characters will cause the build to break on windows OS and on CI. Assuming you clone to the default VisualStudio location such that the root of your clone is `C:\Users\\**USERNAME**\Source\Repos\azure-sdk-for-net` your username will have to be 9 characters long to avoid build errors caused by long paths. Consider using `C:\git` as you clone path. | ||
|
||
**Dependencies :** To ensure that the same versions of dependencies are used for all projects in the repo, package versions are managed from a central location in `eng\Packages.Data.props`. When adding package references you should first ensure that an **Update** reference of the package with the version exist in the **Packages.Data.props** then **Include** the reference without the version in your .csproj. Contact [[email protected]](mailto:[email protected]) if you need to change versions for packages already present in **Packages.Data.props** | ||
|
||
**Line Endings :** If working on windows OS ensure git is installed with `Checkout Windows-style, commit Unix-style` option or `core.autocrlf` set to *true* in git config. If working on Unix based Linux or MacOS ensure git is installed with `Checkout as-is, commit Unix-style` option or `core.autocrlf` set to *input* in git config | ||
# Management Libraries | ||
|
||
## TO BUILD: | ||
|
Oops, something went wrong.