Skip to content

Commit abf1883

Browse files
shogo4405shogo4405
committed
Update README.md and CODE_OF_CONDUCT.md
1 parent 4c81b96 commit abf1883

File tree

19 files changed

+638
-284
lines changed

19 files changed

+638
-284
lines changed

‎.github/CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
name: Bug Report
2-
description: File a bug report
2+
description: |
3+
Before posting, confirm whether the issue can be reproduced in the [Example project](https://github.com/shogo4405/HaishinKit.swift?tab=readme-ov-file#-examples) as well.
34
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report!
49
- type: textarea
510
id: describe-the-bug
611
attributes:

‎Examples/.swiftlint.yml

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
disabled_rules:
2+
- identifier_name
3+
- force_cast
4+
- line_length
5+
- type_body_length
6+
- function_body_length
7+
- file_length
8+
- cyclomatic_complexity
9+
- compiler_protocol_init
10+
analyzer_rules:
11+
- unused_declaration
12+
- unused_import
13+
excluded:
14+
- Carthage
15+
- Pods
16+
- Vendor
17+
- .build
18+
opt_in_rules:
19+
# - anyobject_protocol
20+
- array_init
21+
# - attributes
22+
# - closure_body_length
23+
- closure_end_indentation
24+
- closure_spacing
25+
- collection_alignment
26+
- conditional_returns_on_newline
27+
- contains_over_first_not_nil
28+
- convenience_type
29+
# - discouraged_object_literal
30+
- discouraged_optional_boolean
31+
# - discouraged_optional_collection
32+
- empty_count
33+
- empty_string
34+
# - explicit_acl
35+
# - explicit_enum_raw_value
36+
# - explicit_init
37+
# - explicit_self
38+
# - explicit_type_interface
39+
# - fallthrough
40+
# - file_header
41+
# - file_name
42+
- first_where
43+
# - force_unwrapping
44+
- function_default_parameter_at_end
45+
- identical_operands
46+
# - implicit_return
47+
- joined_default_parameter
48+
- last_where
49+
- legacy_random
50+
- let_var_whitespace
51+
- literal_expression_end_indentation
52+
# - lower_acl_than_parent
53+
# - missing_docs
54+
- modifier_order
55+
- multiline_arguments
56+
- multiline_function_chains
57+
- multiline_literal_brackets
58+
- multiline_parameters
59+
# - no_extension_access_modifier
60+
# - no_grouping_extension
61+
# - number_separator
62+
- operator_usage_whitespace
63+
- overridden_super_call
64+
- override_in_extension
65+
- pattern_matching_keywords
66+
# - prefixed_toplevel_constant
67+
- private_outlet
68+
- private_over_fileprivate
69+
# - prohibited_interface_builder
70+
- quick_discouraged_call
71+
- redundant_nil_coalescing
72+
- redundant_type_annotation
73+
- required_enum_case
74+
- shorthand_operator
75+
- sorted_first_last
76+
- sorted_imports
77+
- static_operator
78+
# - strict_fileprivate
79+
- switch_case_on_newline
80+
- toggle_bool
81+
# - trailing_closure
82+
- unavailable_function
83+
- unneeded_parentheses_in_closure_argument
84+
- untyped_error_in_catch
85+
- vertical_parameter_alignment_on_call
86+
# - vertical_whitespace_between_cases
87+
- vertical_whitespace_closing_braces
88+
- vertical_whitespace_opening_braces
89+
# - yoda_condition

0 commit comments

Comments
 (0)