Skip to content

Commit 7569c37

Browse files
committed
Revert archive changes
1 parent e885ac1 commit 7569c37

8 files changed

Lines changed: 523 additions & 2 deletions

File tree

.github/CODE_OF_CONDUCT.md

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

.github/CONTRIBUTING.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Contributing
2+
3+
Contributions are welcome. I accept pull requests on [GitHub][github].
4+
5+
This project adheres to a [Contributor Code of Conduct][contributor]. By participating in
6+
this project and its community, you are expected to uphold this code.
7+
8+
9+
## Communication Channels
10+
11+
You can find help and discussion in the following places:
12+
13+
* [GitHub Issues][issues]
14+
15+
16+
## Reporting Bugs
17+
18+
Bugs are tracked in the project's [issue tracker][issues].
19+
20+
When submitting a bug report, please include enough information to reproduce the
21+
bug. A good bug report includes the following sections:
22+
23+
* Expected outcome
24+
* Actual outcome
25+
* Steps to reproduce, including sample code
26+
* Any other information that will help debug and reproduce the issue, including
27+
stack traces, system/environment information, and screenshots
28+
29+
**Please do not include passwords or any personally identifiable information in
30+
your bug report and sample code.**
31+
32+
33+
## Fixing Bugs
34+
35+
I welcome pull requests to fix bugs!
36+
37+
If you see a bug report that you'd like to fix, please feel free to do so.
38+
Following the directions and guidelines described in the "Adding New Features"
39+
section below, you may create bugfix branches and send pull requests.
40+
41+
42+
## Adding New Features
43+
44+
If you have an idea for a new feature, it's a good idea to check out the
45+
[issues][] or active [pull requests][] first to see if the feature is already
46+
being worked on. If not, feel free to submit an issue first, asking whether the
47+
feature is beneficial to the project. This will save you from doing a lot of
48+
development work only to have your feature rejected. I don't enjoy rejecting
49+
your hard work, but some features just don't fit with the goals of the project.
50+
51+
When you do begin working on your feature, here are some guidelines to consider:
52+
53+
* Your pull request description should clearly detail the changes you have made.
54+
I will use this description to update the CHANGELOG. If there is no
55+
description or it does not adequately describe your feature, I will ask you
56+
to update the description.
57+
* Our project follows the **[PSR-12 coding standard][psr-12]**. Please
58+
ensure your code does, too.
59+
* Please **write tests** for any new features you add.
60+
* Please **ensure that tests pass** before submitting your pull request.
61+
Our project has CI automatically running tests for pull requests.
62+
However, running the tests locally will help save time.
63+
* **Use topic/feature branches.** Please do not ask to pull from your master
64+
branch.
65+
* For more information, see "[Understanding the GitHub flow][github flow]."
66+
* **Submit one feature per pull request.** If you have multiple features you
67+
wish to submit, please break them up into separate pull requests.
68+
* **Write good commit messages.** Make sure each individual commit in your pull
69+
request is meaningful. If you had to make multiple intermediate commits while
70+
developing, please squash them before submitting.
71+
72+
73+
## Running Tests
74+
75+
The following must pass before I will accept a pull request. If this does not
76+
pass, it will result in a complete build failure. Before you can run this, be
77+
sure to `composer install`.
78+
79+
To run all the tests and coding standards checks, execute the following from the
80+
command line, while in the project root directory (the same place as the
81+
`composer.json` file):
82+
83+
```
84+
composer check
85+
```
86+
87+
88+
[github]: https://github.com/mobicms/container
89+
[contributor]: https://github.com/mobicms/container/blob/master/.github/CODE_OF_CONDUCT.md
90+
[issues]: https://github.com/mobicms/container/issues
91+
[pull requests]: https://github.com/mobicms/container/pulls
92+
[psr-12]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-12-extended-coding-style-guide.md
93+
[github flow]: https://guides.github.com/introduction/flow
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
labels: bug
5+
assignees:
6+
---
7+
8+
## Describe the bug
9+
10+
A clear and concise description of what the bug is.
11+
12+
## To Reproduce...
13+
14+
Steps to reproduce the behavior (include code examples, if applicable):
15+
16+
1. Create script `foo.php` and add the following:
17+
18+
``` php
19+
<?php
20+
require_once 'vendor/autoload.php';
21+
22+
$foo = new Foo\Bar();
23+
24+
// Code that, when run, shows the behavior...
25+
```
26+
27+
2. Execute the script from a terminal:
28+
29+
``` bash
30+
$ php foo.php
31+
```
32+
33+
3. See output similar to the following:
34+
35+
```
36+
Error message or wrong output...
37+
```
38+
39+
## Expected behavior
40+
41+
A clear and concise description of what you expected to happen.
42+
43+
## Screenshots or output
44+
45+
If applicable, add screenshots or program output to help explain your problem.
46+
47+
## Environment details
48+
49+
- OS: [e.g. Windows 10, Linux (Ubuntu 18.04.1), macOS Mojave (10.14.2)]
50+
- PHP version: [e.g. 7.1.25, 7.2.13]
51+
- **mobicms** package version: [e.g. 1.0.0, 1.0.1, 1.1.0]
52+
53+
## Additional context
54+
55+
Add any other context about the problem here.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
labels: enhancement
5+
assignees:
6+
---
7+
8+
## Is your feature request related to a problem? Please describe.
9+
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
## Describe the solution you'd like
13+
14+
A clear and concise description of what you want to happen. Include code examples, if applicable.
15+
16+
## Describe alternatives you've considered
17+
18+
A clear and concise description of any alternative solutions or features you've considered.
19+
20+
## Additional context
21+
22+
Add any other context or code examples about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
3+
## Description
4+
<!--- Describe your changes in detail -->
5+
6+
## Motivation and Context
7+
<!--- Why is this change required? What problem does it solve? -->
8+
<!--- If it fixes an open issue, please link to the issue here. -->
9+
10+
## How Has This Been Tested?
11+
<!--- Please describe in detail how you tested your changes. -->
12+
<!--- Include details of your testing environment, and the tests you ran to -->
13+
<!--- see how your change affects other areas of the code, etc. -->
14+
15+
## Types of changes
16+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
17+
- [ ] Bug fix (non-breaking change which fixes an issue)
18+
- [ ] New feature (non-breaking change which adds functionality)
19+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
20+
21+
## Checklist:
22+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
23+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
24+
- [ ] My code follows the code style of this project.
25+
- [ ] My change requires a change to the documentation.
26+
- [ ] I have updated the documentation accordingly.
27+
- [ ] I have read the **CONTRIBUTING** document.
28+
- [ ] I have added tests to cover my changes.
29+
- [ ] All new and existing tests passed.
30+
- [ ] I have run `composer check` locally, and there were no failures or errors.

.github/workflows/analysis.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: analysis
2+
on: [ push, pull_request ]
3+
4+
jobs:
5+
coding-standard:
6+
name: Coding Standard
7+
runs-on: ubuntu-latest
8+
steps:
9+
- name: Checkout
10+
uses: actions/checkout@v4
11+
12+
- name: Setup PHP
13+
uses: shivammathur/setup-php@v2
14+
with:
15+
php-version: '8.3'
16+
17+
- name: Get composer cache directory
18+
id: composer-cache
19+
run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
20+
21+
- name: Cache dependencies
22+
uses: actions/cache@v4
23+
with:
24+
path: ${{ steps.composer-cache.outputs.dir }}
25+
key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
26+
restore-keys: ${{ runner.os }}-composer-
27+
28+
- name: Install dependencies
29+
run: composer install --no-progress --no-interaction
30+
31+
- name: PHP CodeSniffer
32+
run: composer cs-check
33+
34+
static-analysis:
35+
name: Static Analysis
36+
runs-on: ubuntu-latest
37+
steps:
38+
- name: Checkout
39+
uses: actions/checkout@v4
40+
41+
- name: Setup PHP
42+
uses: shivammathur/setup-php@v2
43+
with:
44+
php-version: '8.3'
45+
46+
- name: Get composer cache directory
47+
id: composer-cache
48+
run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
49+
50+
- name: Cache dependencies
51+
uses: actions/cache@v4
52+
with:
53+
path: ${{ steps.composer-cache.outputs.dir }}
54+
key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
55+
restore-keys: ${{ runner.os }}-composer-
56+
57+
- name: Install dependencies
58+
run: composer install --no-progress --no-interaction
59+
60+
- name: Static Analysis
61+
run: composer static-analysis

0 commit comments

Comments
 (0)