Skip to content
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Contributing

Contributions are **welcome** and will be fully **credited**.

Please read and understand the contribution guide before creating an issue or pull request.

## Etiquette

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.

Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
world that developers are civilized and selfless people.

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.

## Viability

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.

## Procedure

Before filing an issue:

- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
- Check to make sure your feature suggestion isn't already present within the project.
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
- Check the pull requests tab to ensure that the feature isn't already in progress.

Before submitting a pull request:

- Check the codebase to ensure that your feature doesn't already exist.
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.

## Requirements

If the project maintainer has any additional requirements, you will find them listed here.

- **[Magento Coding Standard](https://github.com/magento/magento-coding-standard)** - Follow Magento 2 coding standards (based on PSR-12 with Magento-specific rules)

- **Code Quality Tools** - Run these commands before committing:
```bash
composer install

# Run all checks with GrumPHP (code style + static analysis)
composer grumphp

# Or run checks individually:
composer codestyle # Check code style
composer codestyle:fix # Auto-fix code style issues
composer analyse # Run PHPStan static analysis
```

**Note:** GrumPHP runs automatically on `git commit` and will block commits with code quality issues (both code style and static analysis).

- **Document any change in behaviour** - Make sure the `README.md`, `FEATURES.md` and any other relevant documentation are kept up-to-date.

- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/).

- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.

- **Test in a Magento environment** - Ensure your changes work correctly with:
- Magento 2.4.4+
- PHP 8.2, 8.3, 8.4
- Akeneo Connector Community Edition

**Happy coding**!
149 changes: 149 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
name: Bug Report
description: File a bug report.
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for participating in this project!
Please fill out the following sections to help us understand the issue you're experiencing.

**Before submitting:**
- Make sure you are using the latest version of the extension
- Search existing issues - your question might already be answered
- Include as many details as possible (screenshots, console errors, logs, etc.)

- type: textarea
id: current-behavior
attributes:
label: Current Behavior
description: What is happening?
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: What should happen?
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: Please provide detailed steps to reproduce the issue
placeholder: |
1. Go to '...'
2. Click on '...'
3. Run command '...'
4. See error
validations:
required: true

- type: dropdown
id: affected-feature
attributes:
label: Which feature is affected?
description: Select the feature that is affected by this bug
options:
- Tier Prices
- Tax Class Mapping
- Important Attributes
- Metric Units Import
- Category Import
- Product Import
- Default Store Values
- Exclude Families
- Set Products Active
- Enable Manage Stock
- Set Stock Status
- Remove Redundant EAV
- Format Media Name
- Not Visible Families
- Required Attribute Mapping
- Slack Notifications
- Akeneo Manager
- Event System
- Other / Unknown
validations:
required: true

- type: input
id: magento-version
attributes:
label: Magento Version
placeholder: "e.g., 2.4.7"
validations:
required: true

- type: input
id: akeneo-connector-version
attributes:
label: Akeneo Connector Version
placeholder: "e.g., 105.1.0"
validations:
required: true

- type: input
id: bundle-version
attributes:
label: JustBetter Akeneo Bundle Version
placeholder: "e.g., 2.0.0"
validations:
required: true

- type: input
id: php-version
attributes:
label: PHP Version
placeholder: "e.g., 8.3"
validations:
required: true

- type: input
id: akeneo-version
attributes:
label: Akeneo PIM Version
placeholder: "e.g., 7.0"
validations:
required: false

- type: textarea
id: proposed-solution
attributes:
label: Proposed Solution
description: If you have an idea how to fix this, please share it

- type: textarea
id: logs
attributes:
label: Relevant Log Output
description: Please copy and paste any relevant log output (var/log/akeneo.log, var/log/exception.log, etc.)
render: shell

- type: textarea
id: additional-information
attributes:
label: Additional Information
description: Screenshots, configuration details, or any other relevant information

- type: checkboxes
attributes:
label: Pre-submission Checklist
options:
- label: I have searched the existing issues
required: true
- label: I am using the latest version of the bundle
required: true
- label: I have included all required version information
required: true

- type: checkboxes
attributes:
label: Are you willing to create a pull request for this?
description: Thank you so much for your willingness to help us out! We really appreciate it.
options:
- label: If I have a fix, I would be willing to create a pull request
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: true
contact_links:
- name: 📚 Documentation
url: https://github.com/justbetter/magento2-akeneo-bundle/blob/master/README.md
about: Read the full documentation and feature guide
- name: 💬 Discussions
url: https://github.com/justbetter/magento2-akeneo-bundle/discussions
about: Ask questions and discuss ideas with the community
- name: 🔒 Security Issue
url: https://github.com/justbetter/magento2-akeneo-bundle/security/advisories/new
about: Report a security vulnerability privately
- name: 📧 Contact JustBetter
url: https://justbetter.nl/contact
about: Get in touch with JustBetter for support or inquiries
114 changes: 114 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
name: Feature Request
description: Request a new feature or enhancement.
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for participating in this project!
Please fill out the following sections to help us understand what you want.

**Before submitting:**
- Make sure you are using the latest version of the extension
- Search existing issues and PRs - there might be a similar request already
- Include as many details as possible about your use case

- type: textarea
id: requested-feature
attributes:
label: Feature Description
description: What feature would you like to see added?
placeholder: A clear and concise description of what you want to happen
validations:
required: true

- type: textarea
id: use-case
attributes:
label: Use Case
description: Why would you need this feature? How are you currently limited?
placeholder: Describe your use case and why this feature would be valuable
validations:
required: true

- type: dropdown
id: feature-category
attributes:
label: Feature Category
description: Which area does this feature relate to?
options:
- Product Import
- Category Import
- Attribute Management
- Tax & Pricing
- Visibility & Stock
- Website Association
- Notifications
- Event System
- Configuration
- CLI Commands
- Other
validations:
required: true

- type: textarea
id: proposed-solution
attributes:
label: Proposed Solution
description: How do you envision this feature working?
placeholder: |
Describe the solution you'd like:
- What configuration options would be needed?
- How would it integrate with existing features?
- What would the user workflow look like?

- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: Have you considered any alternative solutions or workarounds?

- type: textarea
id: current-workaround
attributes:
label: Current Workaround
description: How are you currently solving this problem (if at all)?

- type: input
id: magento-version
attributes:
label: Magento Version
placeholder: "e.g., 2.4.7"
validations:
required: false

- type: input
id: bundle-version
attributes:
label: JustBetter Akeneo Bundle Version
placeholder: "e.g., 2.0.0"
validations:
required: false

- type: textarea
id: additional-information
attributes:
label: Additional Information
description: Any other context, screenshots, or examples that would help us understand the request

- type: checkboxes
attributes:
label: Pre-submission Checklist
options:
- label: I have searched the existing issues and pull requests
required: true
- label: I have described my use case clearly
required: true

- type: checkboxes
attributes:
label: Are you willing to create a pull request for this?
description: Thank you so much for your willingness to help us out! We really appreciate it.
options:
- label: I would be willing to create a pull request for this feature
34 changes: 34 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Security Policy

## Supported Versions

We release patches for security vulnerabilities in the following versions:

| Version | Supported |
| ------- | --------- |
| 2.x | ✅ |
| < 2.0 | ❌ |

## Reporting a Vulnerability

We take security seriously. If you discover any security related issues, please report them responsibly.

### Preferred reporting method:

Use [GitHub's private security reporting](https://github.com/justbetter/magento2-akeneo-bundle/security/advisories/new) to report vulnerabilities privately.

### Alternative method:

Email **[email protected]** if you prefer not to use GitHub.

All security vulnerabilities will be promptly addressed.

### What to include in your report:

- Description of the vulnerability
- Steps to reproduce the issue
- Affected versions
- Potential impact
- Suggested fix (if available)

Thank you for helping keep JustBetter Akeneo Bundle and its users safe!
Loading