Skip to content

Commit bea53d4

Browse files
claudio-ferraroclaudio-ferraro
committed
Add documentation, community files, copyright headers and code quality tools
1 parent 6937b11 commit bea53d4

Some content is hidden

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

60 files changed

+1643
-109
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
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+
- **[Magento Coding Standard](https://github.com/magento/magento-coding-standard)** - Follow Magento 2 coding standards (based on PSR-12 with Magento-specific rules)
44+
45+
- **Code Quality Tools** - Run these commands before committing:
46+
```bash
47+
composer install
48+
49+
# Run all checks with GrumPHP (code style + static analysis)
50+
composer grumphp
51+
52+
# Or run checks individually:
53+
composer codestyle # Check code style
54+
composer codestyle:fix # Auto-fix code style issues
55+
composer analyse # Run PHPStan static analysis
56+
```
57+
58+
**Note:** GrumPHP runs automatically on `git commit` and will block commits with code quality issues (both code style and static analysis).
59+
60+
- **Document any change in behaviour** - Make sure the `README.md`, `FEATURES.md` and any other relevant documentation are kept up-to-date.
61+
62+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/).
63+
64+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
65+
66+
- **Test in a Magento environment** - Ensure your changes work correctly with:
67+
- Magento 2.4.4+
68+
- PHP 8.2, 8.3, 8.4
69+
- Akeneo Connector Community Edition
70+
71+
**Happy coding**!

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
name: Bug Report
2+
description: File a bug report.
3+
title: "[Bug]: "
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+
**Before submitting:**
13+
- Make sure you are using the latest version of the extension
14+
- Search existing issues - your question might already be answered
15+
- Include as many details as possible (screenshots, console errors, logs, etc.)
16+
17+
- type: textarea
18+
id: current-behavior
19+
attributes:
20+
label: Current Behavior
21+
description: What is happening?
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: expected-behavior
27+
attributes:
28+
label: Expected Behavior
29+
description: What should happen?
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: steps-to-reproduce
35+
attributes:
36+
label: Steps to Reproduce
37+
description: Please provide detailed steps to reproduce the issue
38+
placeholder: |
39+
1. Go to '...'
40+
2. Click on '...'
41+
3. Run command '...'
42+
4. See error
43+
validations:
44+
required: true
45+
46+
- type: dropdown
47+
id: affected-feature
48+
attributes:
49+
label: Which feature is affected?
50+
description: Select the feature that is affected by this bug
51+
options:
52+
- Tier Prices
53+
- Tax Class Mapping
54+
- Important Attributes
55+
- Metric Units Import
56+
- Category Import
57+
- Product Import
58+
- Default Store Values
59+
- Exclude Families
60+
- Set Products Active
61+
- Enable Manage Stock
62+
- Set Stock Status
63+
- Remove Redundant EAV
64+
- Format Media Name
65+
- Not Visible Families
66+
- Required Attribute Mapping
67+
- Slack Notifications
68+
- Akeneo Manager
69+
- Event System
70+
- Other / Unknown
71+
validations:
72+
required: true
73+
74+
- type: input
75+
id: magento-version
76+
attributes:
77+
label: Magento Version
78+
placeholder: "e.g., 2.4.7"
79+
validations:
80+
required: true
81+
82+
- type: input
83+
id: akeneo-connector-version
84+
attributes:
85+
label: Akeneo Connector Version
86+
placeholder: "e.g., 105.1.0"
87+
validations:
88+
required: true
89+
90+
- type: input
91+
id: bundle-version
92+
attributes:
93+
label: JustBetter Akeneo Bundle Version
94+
placeholder: "e.g., 2.0.0"
95+
validations:
96+
required: true
97+
98+
- type: input
99+
id: php-version
100+
attributes:
101+
label: PHP Version
102+
placeholder: "e.g., 8.3"
103+
validations:
104+
required: true
105+
106+
- type: input
107+
id: akeneo-version
108+
attributes:
109+
label: Akeneo PIM Version
110+
placeholder: "e.g., 7.0"
111+
validations:
112+
required: false
113+
114+
- type: textarea
115+
id: proposed-solution
116+
attributes:
117+
label: Proposed Solution
118+
description: If you have an idea how to fix this, please share it
119+
120+
- type: textarea
121+
id: logs
122+
attributes:
123+
label: Relevant Log Output
124+
description: Please copy and paste any relevant log output (var/log/akeneo.log, var/log/exception.log, etc.)
125+
render: shell
126+
127+
- type: textarea
128+
id: additional-information
129+
attributes:
130+
label: Additional Information
131+
description: Screenshots, configuration details, or any other relevant information
132+
133+
- type: checkboxes
134+
attributes:
135+
label: Pre-submission Checklist
136+
options:
137+
- label: I have searched the existing issues
138+
required: true
139+
- label: I am using the latest version of the bundle
140+
required: true
141+
- label: I have included all required version information
142+
required: true
143+
144+
- type: checkboxes
145+
attributes:
146+
label: Are you willing to create a pull request for this?
147+
description: Thank you so much for your willingness to help us out! We really appreciate it.
148+
options:
149+
- label: If I have a fix, I would be willing to create a pull request

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 📚 Documentation
4+
url: https://github.com/justbetter/magento2-akeneo-bundle/blob/master/README.md
5+
about: Read the full documentation and feature guide
6+
- name: 💬 Discussions
7+
url: https://github.com/justbetter/magento2-akeneo-bundle/discussions
8+
about: Ask questions and discuss ideas with the community
9+
- name: 🔒 Security Issue
10+
url: https://github.com/justbetter/magento2-akeneo-bundle/security/advisories/new
11+
about: Report a security vulnerability privately
12+
- name: 📧 Contact JustBetter
13+
url: https://justbetter.nl/contact
14+
about: Get in touch with JustBetter for support or inquiries

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
name: Feature Request
2+
description: Request a new feature or enhancement.
3+
title: "[Feature]: "
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+
**Before submitting:**
13+
- Make sure you are using the latest version of the extension
14+
- Search existing issues and PRs - there might be a similar request already
15+
- Include as many details as possible about your use case
16+
17+
- type: textarea
18+
id: requested-feature
19+
attributes:
20+
label: Feature Description
21+
description: What feature would you like to see added?
22+
placeholder: A clear and concise description of what you want to happen
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: use-case
28+
attributes:
29+
label: Use Case
30+
description: Why would you need this feature? How are you currently limited?
31+
placeholder: Describe your use case and why this feature would be valuable
32+
validations:
33+
required: true
34+
35+
- type: dropdown
36+
id: feature-category
37+
attributes:
38+
label: Feature Category
39+
description: Which area does this feature relate to?
40+
options:
41+
- Product Import
42+
- Category Import
43+
- Attribute Management
44+
- Tax & Pricing
45+
- Visibility & Stock
46+
- Website Association
47+
- Notifications
48+
- Event System
49+
- Configuration
50+
- CLI Commands
51+
- Other
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: proposed-solution
57+
attributes:
58+
label: Proposed Solution
59+
description: How do you envision this feature working?
60+
placeholder: |
61+
Describe the solution you'd like:
62+
- What configuration options would be needed?
63+
- How would it integrate with existing features?
64+
- What would the user workflow look like?
65+
66+
- type: textarea
67+
id: alternatives
68+
attributes:
69+
label: Alternatives Considered
70+
description: Have you considered any alternative solutions or workarounds?
71+
72+
- type: textarea
73+
id: current-workaround
74+
attributes:
75+
label: Current Workaround
76+
description: How are you currently solving this problem (if at all)?
77+
78+
- type: input
79+
id: magento-version
80+
attributes:
81+
label: Magento Version
82+
placeholder: "e.g., 2.4.7"
83+
validations:
84+
required: false
85+
86+
- type: input
87+
id: bundle-version
88+
attributes:
89+
label: JustBetter Akeneo Bundle Version
90+
placeholder: "e.g., 2.0.0"
91+
validations:
92+
required: false
93+
94+
- type: textarea
95+
id: additional-information
96+
attributes:
97+
label: Additional Information
98+
description: Any other context, screenshots, or examples that would help us understand the request
99+
100+
- type: checkboxes
101+
attributes:
102+
label: Pre-submission Checklist
103+
options:
104+
- label: I have searched the existing issues and pull requests
105+
required: true
106+
- label: I have described my use case clearly
107+
required: true
108+
109+
- type: checkboxes
110+
attributes:
111+
label: Are you willing to create a pull request for this?
112+
description: Thank you so much for your willingness to help us out! We really appreciate it.
113+
options:
114+
- label: I would be willing to create a pull request for this feature

‎.github/SECURITY.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
We release patches for security vulnerabilities in the following versions:
6+
7+
| Version | Supported |
8+
| ------- | --------- |
9+
| 2.x | ✅ |
10+
| < 2.0 | ❌ |
11+
12+
## Reporting a Vulnerability
13+
14+
We take security seriously. If you discover any security related issues, please report them responsibly.
15+
16+
### Preferred reporting method:
17+
18+
Use [GitHub's private security reporting](https://github.com/justbetter/magento2-akeneo-bundle/security/advisories/new) to report vulnerabilities privately.
19+
20+
### Alternative method:
21+
22+
Email **[email protected]** if you prefer not to use GitHub.
23+
24+
All security vulnerabilities will be promptly addressed.
25+
26+
### What to include in your report:
27+
28+
- Description of the vulnerability
29+
- Steps to reproduce the issue
30+
- Affected versions
31+
- Potential impact
32+
- Suggested fix (if available)
33+
34+
Thank you for helping keep JustBetter Akeneo Bundle and its users safe!

0 commit comments

Comments
 (0)