Skip to content

Commit 8ee8b98

Browse files
indykoningindykoning
committed
Updated templates, release 4.0.1
1 parent 30b6e06 commit 8ee8b98

File tree

9 files changed

+194
-6
lines changed

9 files changed

+194
-6
lines changed

‎.github/CONTRIBUTING.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
Please read and understand the contribution guide before creating an issue or pull request.
6+
7+
## Etiquette
8+
9+
This project is open source, and as such, the maintainers give their free time to build and maintain the source code
10+
held within. They make the code freely available in the hope that it will be of use to other developers. It would be
11+
extremely unfair for them to suffer abuse or anger for their hard work.
12+
13+
Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
14+
world that developers are civilized and selfless people.
15+
16+
It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
17+
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.
18+
19+
## Viability
20+
21+
When requesting or submitting new features, first consider whether it might be useful to others. Open
22+
source projects are used by many developers, who may have entirely different needs to your own. Think about
23+
whether or not your feature is likely to be used by other users of the project.
24+
25+
## Procedure
26+
27+
Before filing an issue:
28+
29+
- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
30+
- Check to make sure your feature suggestion isn't already present within the project.
31+
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
32+
- Check the pull requests tab to ensure that the feature isn't already in progress.
33+
34+
Before submitting a pull request:
35+
36+
- Check the codebase to ensure that your feature doesn't already exist.
37+
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
38+
39+
## Requirements
40+
41+
If the project maintainer has any additional requirements, you will find them listed here.
42+
43+
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)**
44+
45+
To save time on codestyle feedback, please run
46+
- `composer install`
47+
- `composer run codestyle`
48+
- `composer run analyse`
49+
50+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
51+
52+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
53+
54+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
55+
56+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
57+
58+
**Happy coding**!

‎.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Bug Report
2+
description: File a bug report.
3+
title: "[🐛]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for participating in this project!
10+
Please fill out the following sections to help us understand the issue you're experiencing.
11+
12+
In any case,
13+
- make sure you are using the latest version of the extension;
14+
- do at least one search in current issues or questions, your question might already be answered;
15+
- do include as many details as possible - site URL with the issue, screenshots when it's a visual issue, console errors, ...;
16+
- type: textarea
17+
id: current-behavior
18+
attributes:
19+
label: What is the current behavior?
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: expected-behavior
24+
attributes:
25+
label: What is the expected behavior?
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: steps-to-reproduce
30+
attributes:
31+
label: How can we reproduce the issue?
32+
- type: textarea
33+
id: proposed-solution
34+
attributes:
35+
label: What is the proposed solution?
36+
- type: textarea
37+
id: additional-information
38+
attributes:
39+
label: do you have any additional information for us?
40+
description: Please include any additional information that may be helpful in resolving the issue. Like logs, screenshots, or any other relevant details.
41+
- type: checkboxes
42+
attributes:
43+
label: Is there an existing issue for this?
44+
description: Please search to see if an issue already exists for the bug you encountered.
45+
options:
46+
- label: I have searched the existing issues
47+
required: true
48+
- type: checkboxes
49+
attributes:
50+
label: Are you willing to create a pull request for this?
51+
description: Thank you so much for your willingness to help us out! We really appreciate it.
52+
options:
53+
- label: If i have a fix i would be willing to create a pull request

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
contact_links:
2+
- name: Security Report
3+
url: https://github.com/justbetter/magento2-sentry/security/policy
4+
about: Please see our security policy.

‎.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Feature Request
2+
description: Create a feature request.
3+
title: "[⭐]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for participating in this project!
10+
Please fill out the following sections to help us understand what you want.
11+
12+
In any case,
13+
- make sure you are using the latest version of the extension;
14+
- do at least one search in current issues or feature requests, there might be a similar request already where you could help out;
15+
- do include as many details as possible;
16+
- type: textarea
17+
id: requested-feature
18+
attributes:
19+
label: What feature would you like to see added?
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: current-behavior
24+
attributes:
25+
label: If it is related to current behavior, what is the current behavior?
26+
- type: textarea
27+
id: additional-information
28+
attributes:
29+
label: do you have any additional information for us?
30+
- type: checkboxes
31+
attributes:
32+
label: Is there an existing Feature Request/PR for this?
33+
description: Please search to see if a feature request or PR already exists for the feature you would like.
34+
options:
35+
- label: I have searched the existing issues and pull requests
36+
required: true
37+
- type: checkboxes
38+
attributes:
39+
label: Are you willing to create a pull request for this?
40+
description: Thank you so much for your willingness to help us out! We really appreciate it.
41+
options:
42+
- label: I would be willing to create a pull request for this feature

‎.github/SECURITY.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Security Policy
2+
3+
If you discover any security related issues, please email [email protected] instead of using the issue tracker.

‎.github/ISSUE_TEMPLATE.md renamed to ‎.github/issue_template.md

File renamed without changes.

‎CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# Changelog
2+
## [4.0.1] - 2025-05-06
3+
### Fixed
4+
* Load customerSession in SentryLog via proxy (Fixing https://github.com/justbetter/magento2-sentry/issues/160) (https://github.com/justbetter/magento2-sentry/pull/169) thanks to https://github.com/brosenberger
25
## [4.0.0] - 2025-04-23
36
### Added
47
* Moved sentry logging to a monolog handler (https://github.com/justbetter/magento2-sentry/pull/165)

‎README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
![Magento Support](https://img.shields.io/badge/magento-2.4-orange.svg?logo=magento&longCache=true&style=flat-square)
1010
[![PHPStan passing](https://img.shields.io/github/actions/workflow/status/justbetter/magento2-sentry/analyse.yml?label=PHPStan&style=flat-square)](https://github.com/justbetter/magento2-sentry/actions/workflows/analyse.yml)
1111

12-
This Magento 2 module integrates the [Sentry sdk](https://github.com/getsentry/sentry-php) into magento 2. Depending on the log level configured in the backend of magento 2, notifications and errors can be send to sentry.
12+
This Magento 2 module integrates [Sentry](https://github.com/getsentry/sentry-php) into magento 2.
13+
Depending on the log level configured in the backend of magento 2, notifications and errors can be sent to sentry.
1314

1415
## Features
1516

@@ -114,18 +115,23 @@ Please create a [issue](https://github.com/justbetter/magento2-sentry/issues) or
114115
## Contributing
115116
Contributing? Awesome! Thank you for your help improving the module!
116117

118+
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
119+
120+
Most importantly:
117121
- When making a PR please add a description what you've added, and if relevant why.
118122
- To save time on codestyle feedback, please run
119123
- `composer install`
120124
- `composer run codestyle`
121125
- `composer run analyse`
122126

123-
## About us
124-
We’re a innovative development agency from The Netherlands building awesome websites, webshops and web applications with Laravel and Magento. Check out our website [justbetter.nl](https://justbetter.nl) and our [open source projects](https://github.com/justbetter).
127+
## Security Vulnerabilities
128+
129+
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
125130

126131
## License
127-
[MIT](LICENSE)
132+
133+
The MIT License (MIT). Please see [License File](LICENSE) for more information.
128134

129135
<a href="https://justbetter.nl" title="JustBetter">
130-
<img src="./.github/assets/footer.svg" alt="Package footer">
136+
<img src="./.github/assets/footer.svg" alt="We’re a innovative development agency from The Netherlands.">
131137
</a>

‎composer.json

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
11
{
22
"name": "justbetter/magento2-sentry",
33
"description": "Magento 2 Logger for Sentry",
4+
"keywords": [
5+
"PHP",
6+
"Magento",
7+
"Magento 2",
8+
"javascript",
9+
"Sentry",
10+
"Logger",
11+
"Logging",
12+
"Error",
13+
"Error Reporting",
14+
"Error Tracking",
15+
"Exception",
16+
"Exception Reporting",
17+
"Exception Tracking",
18+
"Session Replay",
19+
"Logrocket",
20+
"Tracing",
21+
"Performance"
22+
],
423
"type": "magento2-module",
5-
"version": "4.0.0",
24+
"version": "4.0.1",
625
"license": "MIT",
726
"require": {
827
"php": ">=8.0",

0 commit comments

Comments
 (0)