Skip to content

Commit c28d3df

Browse files
authored
Prepare for 0.1.0 release (#54)
* Prepare for 0.1.0 release * Add contributing guideline with branching info * Update changelog. Add .editorconfig * Update codecov settings * Update contributing copyright template * Update release workflow Signed-off-by: Victor Chang <[email protected]>
1 parent 2b900d6 commit c28d3df

File tree

7 files changed

+888
-421
lines changed

7 files changed

+888
-421
lines changed

.editorconfig

+189
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
1+
# editorconfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
# Default settings:
7+
# A newline ending every file
8+
# Use 4 spaces as indentation
9+
[*]
10+
insert_final_newline = true
11+
indent_style = space
12+
indent_size = 4
13+
trim_trailing_whitespace = true
14+
15+
# Generated code
16+
[*{_AssemblyInfo.cs,.notsupported.cs,AsmOffsets.cs}]
17+
generated_code = true
18+
19+
# C# files
20+
[*.cs]
21+
# New line preferences
22+
csharp_new_line_before_open_brace = all
23+
csharp_new_line_before_else = true
24+
csharp_new_line_before_catch = true
25+
csharp_new_line_before_finally = true
26+
csharp_new_line_before_members_in_object_initializers = true
27+
csharp_new_line_before_members_in_anonymous_types = true
28+
csharp_new_line_between_query_expression_clauses = true
29+
30+
# Indentation preferences
31+
csharp_indent_block_contents = true
32+
csharp_indent_braces = false
33+
csharp_indent_case_contents = true
34+
csharp_indent_case_contents_when_block = true
35+
csharp_indent_switch_labels = true
36+
csharp_indent_labels = one_less_than_current
37+
38+
# Modifier preferences
39+
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
40+
41+
# avoid this. unless absolutely necessary
42+
dotnet_style_qualification_for_field = false:suggestion
43+
dotnet_style_qualification_for_property = false:suggestion
44+
dotnet_style_qualification_for_method = false:suggestion
45+
dotnet_style_qualification_for_event = false:suggestion
46+
47+
# Types: use keywords instead of BCL types, and permit var only when the type is clear
48+
csharp_style_var_for_built_in_types = false:suggestion
49+
csharp_style_var_when_type_is_apparent = false:none
50+
csharp_style_var_elsewhere = false:suggestion
51+
dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
52+
dotnet_style_predefined_type_for_member_access = true:suggestion
53+
54+
# name all constant fields using PascalCase
55+
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
56+
dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields
57+
dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style
58+
dotnet_naming_symbols.constant_fields.applicable_kinds = field
59+
dotnet_naming_symbols.constant_fields.required_modifiers = const
60+
dotnet_naming_style.pascal_case_style.capitalization = pascal_case
61+
62+
# static fields should have s_ prefix
63+
dotnet_naming_rule.static_fields_should_have_prefix.severity = suggestion
64+
dotnet_naming_rule.static_fields_should_have_prefix.symbols = static_fields
65+
dotnet_naming_rule.static_fields_should_have_prefix.style = static_prefix_style
66+
dotnet_naming_symbols.static_fields.applicable_kinds = field
67+
dotnet_naming_symbols.static_fields.required_modifiers = static
68+
dotnet_naming_symbols.static_fields.applicable_accessibilities = private, internal, private_protected
69+
dotnet_naming_style.static_prefix_style.required_prefix = s_
70+
dotnet_naming_style.static_prefix_style.capitalization = camel_case
71+
72+
# internal and private fields should be _camelCase
73+
dotnet_naming_rule.camel_case_for_private_internal_fields.severity = suggestion
74+
dotnet_naming_rule.camel_case_for_private_internal_fields.symbols = private_internal_fields
75+
dotnet_naming_rule.camel_case_for_private_internal_fields.style = camel_case_underscore_style
76+
dotnet_naming_symbols.private_internal_fields.applicable_kinds = field
77+
dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal
78+
dotnet_naming_style.camel_case_underscore_style.required_prefix = _
79+
dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case
80+
81+
# Code style defaults
82+
csharp_using_directive_placement = outside_namespace:suggestion
83+
dotnet_sort_system_directives_first = true
84+
csharp_prefer_braces = true:silent
85+
csharp_preserve_single_line_blocks = true:none
86+
csharp_preserve_single_line_statements = false:none
87+
csharp_prefer_static_local_function = true:suggestion
88+
csharp_prefer_simple_using_statement = false:none
89+
csharp_style_prefer_switch_expression = true:suggestion
90+
dotnet_style_readonly_field = true:suggestion
91+
92+
# Expression-level preferences
93+
dotnet_style_object_initializer = true:suggestion
94+
dotnet_style_collection_initializer = true:suggestion
95+
dotnet_style_explicit_tuple_names = true:suggestion
96+
dotnet_style_coalesce_expression = true:suggestion
97+
dotnet_style_null_propagation = true:suggestion
98+
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
99+
dotnet_style_prefer_inferred_tuple_names = true:suggestion
100+
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
101+
dotnet_style_prefer_auto_properties = true:suggestion
102+
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
103+
dotnet_style_prefer_conditional_expression_over_return = true:silent
104+
csharp_prefer_simple_default_expression = true:suggestion
105+
106+
# Expression-bodied members
107+
csharp_style_expression_bodied_methods = true:silent
108+
csharp_style_expression_bodied_constructors = true:silent
109+
csharp_style_expression_bodied_operators = true:silent
110+
csharp_style_expression_bodied_properties = true:silent
111+
csharp_style_expression_bodied_indexers = true:silent
112+
csharp_style_expression_bodied_accessors = true:silent
113+
csharp_style_expression_bodied_lambdas = true:silent
114+
csharp_style_expression_bodied_local_functions = true:silent
115+
116+
# Pattern matching
117+
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
118+
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
119+
csharp_style_inlined_variable_declaration = true:suggestion
120+
121+
# Null checking preferences
122+
csharp_style_throw_expression = true:suggestion
123+
csharp_style_conditional_delegate_call = true:suggestion
124+
125+
# Other features
126+
csharp_style_prefer_index_operator = false:none
127+
csharp_style_prefer_range_operator = false:none
128+
csharp_style_pattern_local_over_anonymous_function = false:none
129+
130+
# Space preferences
131+
csharp_space_after_cast = false
132+
csharp_space_after_colon_in_inheritance_clause = true
133+
csharp_space_after_comma = true
134+
csharp_space_after_dot = false
135+
csharp_space_after_keywords_in_control_flow_statements = true
136+
csharp_space_after_semicolon_in_for_statement = true
137+
csharp_space_around_binary_operators = before_and_after
138+
csharp_space_around_declaration_statements = do_not_ignore
139+
csharp_space_before_colon_in_inheritance_clause = true
140+
csharp_space_before_comma = false
141+
csharp_space_before_dot = false
142+
csharp_space_before_open_square_brackets = false
143+
csharp_space_before_semicolon_in_for_statement = false
144+
csharp_space_between_empty_square_brackets = false
145+
csharp_space_between_method_call_empty_parameter_list_parentheses = false
146+
csharp_space_between_method_call_name_and_opening_parenthesis = false
147+
csharp_space_between_method_call_parameter_list_parentheses = false
148+
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
149+
csharp_space_between_method_declaration_name_and_open_parenthesis = false
150+
csharp_space_between_method_declaration_parameter_list_parentheses = false
151+
csharp_space_between_parentheses = false
152+
csharp_space_between_square_brackets = false
153+
154+
# License header
155+
file_header_template = Licensed to the .NET Foundation under one or more agreements.\nThe .NET Foundation licenses this file to you under the MIT license.
156+
157+
# C++ Files
158+
[*.{cpp,h,in}]
159+
curly_bracket_next_line = true
160+
indent_brace_style = Allman
161+
162+
# Xml project files
163+
[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,nativeproj,locproj}]
164+
indent_size = 2
165+
166+
[*.{csproj,vbproj,proj,nativeproj,locproj}]
167+
charset = utf-8
168+
169+
# Xml build files
170+
[*.builds]
171+
indent_size = 2
172+
173+
# Xml files
174+
[*.{xml,stylecop,resx,ruleset}]
175+
indent_size = 2
176+
177+
# Xml config files
178+
[*.{props,targets,config,nuspec}]
179+
indent_size = 2
180+
181+
# YAML config files
182+
[*.{yml,yaml}]
183+
indent_size = 2
184+
185+
# Shell scripts
186+
[*.sh]
187+
end_of_line = lf
188+
[*.{cmd,bat}]
189+
end_of_line = crlf

0 commit comments

Comments
 (0)