Skip to content

Commit

Permalink
Merge pull request #24 from flagbit/add-branch-compatibility-docs
Browse files Browse the repository at this point in the history 
Improve readme with new documentation and contribution guidelines
  • Loading branch information
Antonio Mansilla authored Jun 17, 2019
2 parents c91c209 + 3ccf80d commit 3fbb6d9
Show file tree
Hide file tree
Showing 3 changed files with 156 additions and 34 deletions.
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting
as an appointed representative at an online or offline event. Representation of
a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Contributing

Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.

## Branch Compatibility

| Branch | Akeneo Compatibility |
| ------------- |:-------------:|
| `master` | `>= 2.0.5 & < 3.0.0` |
| `2.0` | `>= 2.0.0 & < 2.0.5` |
| `1.X` | `>= 1.6.0 & < 2.0.0` |
103 changes: 69 additions & 34 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,21 +1,60 @@
# Flagbit TableAttributeBundle for Akeneo PIM #
<h1 align="center">
Flagbit Table Attribute for Akeneo PIM
<br>
</h1>

<h4 align="center">Adds the new attribute type Table for Akeneo products.</h4>

<p align="center">
<a href="https://travis-ci.org/flagbit/akeneo-table-attribute-bundle">
<img src="https://img.shields.io/travis/flagbit/akeneo-table-attribute-bundle/master.svg?style=flat-square"/>
</a>
<img src="https://poser.pugx.org/flagbit/table-attribute-bundle/downloads?format=flat-square">
<a href="https://scrutinizer-ci.com/g/Flagbit/akeneo-table-attribute-bundle">
<img src="https://img.shields.io/scrutinizer/g/flagbit/akeneo-table-attribute-bundle.svg?style=flat-square">
</a>
<a href="https://packagist.org/packages/flagbit/table-attribute-bundle">
<img src="https://img.shields.io/packagist/v/flagbit/table-attribute-bundle.svg?style=flat-square">
</a>
<a href="LICENSE">
<img src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square">
</a>
</p>

<p align="center">
<a href="#key-features">Key Features</a> •
<a href="#installation">Installation</a> •
<a href="#compatibility">Compatibility</a> •
<a href="#development">Development</a> •
<a href="#contributing">Contributing</a>
</p>

## Key Features

Provides a _table_ as attribute type where you can define a set of columns of different types and validation rules.

#### Column Types

[![Build Status](https://img.shields.io/travis/flagbit/akeneo-table-attribute-bundle/master.svg?style=flat-square)](https://travis-ci.org/flagbit/akeneo-table-attribute-bundle)
[![Quality Score](https://img.shields.io/scrutinizer/g/flagbit/akeneo-table-attribute-bundle.svg?style=flat-square)](https://scrutinizer-ci.com/g/Flagbit/akeneo-table-attribute-bundle)
[![Packagist Version](https://img.shields.io/packagist/v/flagbit/table-attribute-bundle.svg?style=flat-square)](https://packagist.org/packages/flagbit/table-attribute-bundle)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
* Text
* Number (Integer or Decimal)
* Simple select
* Simple select from URL

#### Import/Export

Adds the new attribute type *Table* for Akeneo products.
The extension supports the standard Akeneo product import/export, so you don't need to create any special import/export profile for table information.

## Installation ##
All product information related to attributes of type _table_ will be imported/exported as JSON.

Now you can simply install the package with the following command.
## Installation

Simply install the package with the following command:

``` bash
composer require flagbit/table-attribute-bundle
```

### Enable the bundle ###
### Enable the bundle

Enable the bundle in the kernel:

Expand All @@ -33,9 +72,9 @@ protected function registerProjectBundles()
}
```

### Configuration ###
### Configuration

Add to config yml to `mapping_overrides` in `app/config/config.yml`:
Add `mapping_overrides` in `app/config/config.yml`:

``` yml
akeneo_storage_utils:
Expand All @@ -45,7 +84,7 @@ akeneo_storage_utils:
override: Flagbit\Bundle\TableAttributeBundle\Entity\AttributeOption
```
Clear your cache:
Clear the cache:
``` bash
php bin/console --env=prod cache:clear
Expand All @@ -60,7 +99,7 @@ php bin/console --env=prod doctrine:schema:update --force
Build and install the new front-end dependencies (new icon, etc.)

``` bash
php bin/console pim:installer:assets --symlink --clean --env=prod
php bin/console --env=prod pim:installer:assets --symlink --clean
yarn run webpack
```

Expand All @@ -76,30 +115,16 @@ and migrate the schema updates:
php bin/console --env=prod doctrine:migrations:migrate
```

## Features ##

Provides a the table as attribute type where you can define a set of columns of different types and validation rules.

#### Column Types ####
* Text
* Number (Integer or Decimal)
* Simple select
* Simple select from URL

#### Import/Export ####
The extension supports the standard Akeneo product import/export, so you don't need to create any special import/export
profile for table information.

All product information related to attributes of type _table_ will be imported/exported as JSON.

## Akeneo Compatibility ##
## Compatibility

This extension supports the latest Akeneo PIM CE/EE stable versions:

* 2.3 (LTS)
* 2.1 and 2.2 (STS)

## Running Test-Suits ##
## Development

### Running Test-Suits

The TableAttributeBundle is covered with tests and every change and addition has also to be covered with
unit or/and integration tests. It uses two testing suits: [PHPSpec](https://www.phpspec.net) and
Expand All @@ -112,7 +137,7 @@ vendor/bin/phpunit
vendor/bin/phpspec run
```

## Coding style ##
### Coding style

TableAttributeBundle uses the [PSR-2](https://www.php-fig.org/psr/psr-2/) coding style and can be checked with
[Codesniffer](https://github.com/squizlabs/PHP_CodeSniffer).
Expand All @@ -121,6 +146,16 @@ TableAttributeBundle uses the [PSR-2](https://www.php-fig.org/psr/psr-2/) coding
vendor/bin/phpcs --standard=PSR2 --extensions=php ./src
```

## License ##
## Contributing

Contributions are always welcome! Please have a look at the [contribution guidelines](CONTRIBUTING.md) first.

## License

The TableAttributeBundle is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

#

The TableAttributeBundle is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
<p align="center">
Supported with ❤ by <a href="https://www.flagbit.de">Flagbit GmbH & Co. KG</a>
</p>

0 comments on commit 3fbb6d9

Please sign in to comment.