Skip to content

Commit 1acf71c

Browse files
Initial commit
0 parents  commit 1acf71c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+8706
-0
lines changed

.editorconfig

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
; This file is for unifying the coding style for different editors and IDEs.
2+
; More information at http://editorconfig.org
3+
4+
root = true
5+
6+
[*]
7+
charset = utf-8
8+
indent_size = 4
9+
indent_style = space
10+
end_of_line = lf
11+
insert_final_newline = true
12+
trim_trailing_whitespace = true
13+
14+
[*.js]
15+
indent_size = 2
16+
17+
[*.json]
18+
indent_size = 2
19+
20+
[*.json.dist]
21+
indent_size = 2
22+
23+
[*.json5]
24+
indent_size = 2
25+
26+
[*.json5.dist]
27+
indent_size = 2
28+
29+
[*.md]
30+
trim_trailing_whitespace = false
31+
32+
[*.neon]
33+
indent_size = 2
34+
35+
[*.neon.dist]
36+
indent_size = 2
37+
38+
[*.xml]
39+
indent_size = 2
40+
41+
[*.xml.dist]
42+
indent_size = 2
43+
44+
[*.yml]
45+
indent_size = 2
46+
47+
[*.yml.dist]
48+
indent_size = 2

.gitattributes

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Path-based git attributes
2+
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
3+
4+
# Ignore all test and documentation with "export-ignore".
5+
/.github/ export-ignore
6+
/tests/ export-ignore
7+
/.editorconfig export-ignore
8+
/.gitattributes export-ignore
9+
/.gitignore export-ignore
10+
/infection.json.dist export-ignore
11+
/phpcs.xml.dist export-ignore
12+
/phpstan.neon.dist export-ignore
13+
/phpunit.github-actions.up-to-9.xml.dist export-ignore
14+
/phpunit.github-actions.xml.dist export-ignore
15+
/phpunit.xml.dist export-ignore

.github/CODE_OF_CONDUCT.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
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, caste, color, religion, or sexual
10+
identity 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 overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
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 address,
35+
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 email 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+
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 of
86+
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 permanent
93+
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 the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

.github/CONTRIBUTING.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Contributing
2+
3+
Please read and understand the contribution guide before creating an issue or pull request.
4+
5+
Contributions will be fully credited.
6+
7+
8+
9+
### Please Note
10+
11+
- One of the maintainers' goals is to keep the project concise, so not all PRs will be accepted.
12+
- Maintainers will need to maintain new code for its lifetime, so discretion is used when considering a PR for acceptance.
13+
- If you're unsure, feel free to drop us a line first.
14+
15+
16+
17+
## Etiquette
18+
19+
This project is open source, and as such, the maintainers give their free time to build and maintain the source code held within. They make the code freely available in the hope that it will be of use to other developers. It would be extremely unfair for them to suffer abuse or anger for their hard work.
20+
21+
Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the world that developers are civilized and selfless people.
22+
23+
It's the duty of the maintainer to ensure that all submissions to the project are of sufficient quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
24+
25+
26+
27+
## Viability
28+
29+
When requesting or submitting new features, first consider whether it might be useful to others. Open source projects are used by many developers, who may have entirely different needs to your own. Think about whether or not your feature is likely to be used by other users of the project.
30+
31+
32+
33+
## Procedure
34+
35+
Before filing an issue:
36+
37+
- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
38+
- Check to make sure your feature suggestion isn't already present within the project.
39+
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
40+
- Check the pull requests tab to ensure that the feature isn't already in progress.
41+
42+
Before submitting a pull request:
43+
44+
- Check the codebase to ensure that your feature doesn't already exist.
45+
- Please raise an issue to discuss the problem first.
46+
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
47+
48+
49+
50+
## Requirements
51+
52+
- *[PSR-12 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-12-extended-coding-style-guide.md)* where possible - falling back to [PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) otherwise - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer).
53+
54+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
55+
56+
- **Document any change in behaviour** - Clearly note any changes, so [Clarity Control's documentation](https://github.com/code-distortion/clarity-control) can be updated.
57+
58+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is to be avoided.
59+
60+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
61+
62+
- **Coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.

.github/ISSUE_TEMPLATE.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
#### Summary:
2+
3+
<!-- Please provide a quick summary of the issue here -->
4+
5+
6+
7+
#### Versions:
8+
9+
- Clarity Control version:
10+
- Clarity Context version (if used):
11+
- Clarity Logger version (if used):
12+
- Laravel version:
13+
- PHP version:
14+
- OS + version:
15+
16+
17+
18+
#### Detailed Description:
19+
20+
<!-- Please provide a detailed description of the issue here, if needed -->
21+
22+
23+
24+
#### Current Behaviour:
25+
26+
<!-- Please explain the current behaviour here -->
27+
28+
29+
30+
#### How To Reproduce:
31+
32+
<!-- Please list steps to reproduce the issue here if possible -->
33+
<!-- This will greatly help in diagnosing the issue -->
34+
<!-- Include details about any relevant factors -->
35+
36+
37+
38+
#### Expected Behaviour:
39+
40+
<!-- Please explain the behaviour you would expect here -->
41+
42+
43+
44+
#### Additional Information:
45+
46+
<!-- Please add any extra information that you might think is relevant -->

0 commit comments

Comments
 (0)