Skip to content

Commit 7703540

Browse files
committed
chore: Update README and add issue templates for bug reports and feature requests
1 parent a56f599 commit 7703540

8 files changed

Lines changed: 524 additions & 83 deletions

File tree

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Call script with parameters ...
16+
2. Type ...
17+
3. Wait for ... seconds
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. MacOS]
28+
- make version (make --version)
29+
- Script version
30+
- copy/paste output
31+
32+
**Additional context**
33+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/workflows/php.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: PHP CI
2+
on:
3+
push:
4+
branches: [ main ]
5+
pull_request:
6+
branches: [ main ]
7+
# Allows you to run this workflow manually from the Actions tab
8+
workflow_dispatch:
9+
10+
jobs:
11+
test:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout code
15+
uses: actions/checkout@v4
16+
17+
- name: Set up PHP 5.5
18+
uses: shivammathur/setup-php@v2
19+
with:
20+
php-version: 5.5
21+
tools: composer
22+
23+
- name: Cache Composer packages
24+
uses: actions/cache@v4
25+
with:
26+
path: ~/.composer/cache/files
27+
key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
28+
restore-keys: ${{ runner.os }}-composer-
29+
30+
- name: Install dependencies
31+
run: composer install
32+
33+
- name: Run tests
34+
run: ./vendor/bin/simple-phpunit

.travis.yml

Lines changed: 0 additions & 28 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 44 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,44 @@
1-
CHANGELOG
2-
=========
3-
4-
### 2018-11-25
5-
- Updated Makefile
6-
- phpunit.xml.dist whitelist bug
7-
- gitignore /coverage
8-
- Updated README
9-
- Updated travis
10-
11-
### 2018-10-10
12-
- Travis continuous integration
13-
14-
### 2018-09-26
15-
- Optimization CallbackTest
16-
- Removed composer.lock
17-
18-
### 2018-08-19
19-
- Units tests and dependencies
20-
- v2.1.0 New release
21-
22-
### 2018-04-08
23-
- Copyright notice
24-
25-
### 2017-10-11
26-
- MIT Licence
27-
- Callback is no longer a filter
28-
- Updated README
29-
- Function accepts '_route' and '_route_params' as parameters
30-
- v2.0.0 New release
31-
32-
### 2017-08-18
33-
- v1.0.0 Initial release
1+
Change Log
2+
==========
3+
4+
All notable changes to this project will be documented in this file.
5+
6+
The format is based on [Keep a Changelog](http://keepachangelog.com/)
7+
and this project adheres to [Semantic Versioning](http://semver.org/).
8+
9+
## 2025-07-11
10+
- Updated README
11+
- Migrate travis configuration to github actions
12+
- Added issue templates for bug reports and feature requests
13+
- Added code of conduct
14+
15+
## 2018-11-25
16+
- Updated Makefile
17+
- phpunit.xml.dist whitelist bug
18+
- gitignore /coverage
19+
- Updated README
20+
- Updated travis
21+
22+
## 2018-10-10
23+
- Travis continuous integration
24+
25+
## 2018-09-26
26+
- Optimization CallbackTest
27+
- Removed composer.lock
28+
29+
## 2018-08-19 [2.1.0](https://github.com/TangoMan75/CallbackBundle/releases/tag/2.1.0)
30+
- Units tests and dependencies
31+
- v2.1.0 New release
32+
33+
## 2018-04-08
34+
- Copyright notice
35+
36+
## 2017-10-11 [2.0.0](https://github.com/TangoMan75/CallbackBundle/releases/tag/2.0.0)
37+
- MIT Licence
38+
- Callback is no longer a filter
39+
- Updated README
40+
- Function accepts '_route' and '_route_params' as parameters
41+
- v2.0.0 New release
42+
43+
## 2017-08-18 [1.0.0](https://github.com/TangoMan75/CallbackBundle/releases/tag/1.0.0)
44+
- v1.0.0 Initial release

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at mat@tangoman.io. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

0 commit comments

Comments
 (0)