Skip to content

Commit f8949b8

Browse files
committed
Add documentation
1 parent 1a8fb40 commit f8949b8

File tree

4 files changed

+150
-0
lines changed

4 files changed

+150
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/vendor

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
5+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
6+
7+
## 0.1.0 - 2019-02-14
8+
### Added
9+
- Closes session at the beginning of `customer/section/load` AJAX requests

CONTRIBUTING.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Contributing to IntegerNet_SessionUnblocker
2+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
3+
4+
- Reporting a bug
5+
- Discussing the current state of the code
6+
- Submitting a fix
7+
- Proposing new features
8+
- Becoming a maintainer
9+
10+
## We Develop with Github
11+
We use github to host code, to track issues and feature requests, as well as accept pull requests.
12+
13+
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
14+
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
15+
16+
1. Fork the repo and create your branch from `master`.
17+
2. If you've added code that should be tested, add tests.
18+
3. If you've changed APIs, update the documentation.
19+
4. Ensure the test suite passes.
20+
5. Make sure your code lints.
21+
6. Issue that pull request!
22+
23+
## Any contributions you make will be under the MIT Software License
24+
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
25+
26+
## Report bugs using Github's [issues](https://github.com/integer-net/magento2-session-unblocker/issues)
27+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/integer-net/magento2-session-unblocker/issues/new); it's that easy!
28+
29+
## Write bug reports with detail, background, and sample code
30+
[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report I wrote, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer whom I greatly respect.
31+
32+
**Great Bug Reports** tend to have:
33+
34+
- A quick summary and/or background
35+
- Steps to reproduce
36+
- Be specific!
37+
- Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce what I was seeing
38+
- What you expected would happen
39+
- What actually happens
40+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
41+
42+
People *love* thorough bug reports. I'm not even kidding.
43+
44+
## Pull Requests
45+
46+
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - Check the code style with ``$ composer check-style`` and fix it with ``$ composer fix-style``.
47+
48+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
49+
50+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
51+
52+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
53+
54+
- **Create feature branches** - Don't ask us to pull from your master branch.
55+
56+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
57+
58+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
59+
60+
## License
61+
By contributing, you agree that your contributions will be licensed under its MIT License.
62+
63+
## References
64+
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md) with additions from [ThePhpLeague Template](https://github.com/thephpleague/skeleton)

README.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Integer_Net Session Unblocker
2+
3+
[![Software License][ico-license]](LICENSE.md)
4+
[![Build Status][ico-travis]][link-travis]
5+
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
6+
[![Quality Score][ico-code-quality]][link-code-quality]
7+
8+
9+
This extension improves the performance of AJAX requests in Magento by reducing session locking, without having to disable locking in the cache backend (e.g. Redis)
10+
11+
Session locking keeps safe from race conditions from parallel requests, so disabling it completely can result in session data loss.
12+
13+
Instead we minimize the lock time by closing the session as soon as we have read it, if we do not need to write to it anymore.
14+
15+
## Installation
16+
17+
1. Install via composer
18+
```
19+
composer require integer-net/magento2-session-unblocker
20+
```
21+
2. Enable module
22+
```
23+
bin/magento setup:upgrade
24+
```
25+
## Configuration
26+
27+
Zero configuration needed.
28+
29+
## Change log
30+
31+
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
32+
33+
## Testing
34+
35+
### Magento Integration Tests
36+
37+
0. Configure test database in `dev/tests/integration/etc/install-config-mysql.php`. [Read more in the Magento docs.](https://devdocs.magento.com/guides/v2.3/test/integration/integration_test_execution.html)
38+
39+
1. Copy `Test/Integration/phpunit.xml.dist` from the package to `dev/tests/integration/phpunit.xml` in your Magento installation.
40+
41+
2. In that directory, run
42+
``` bash
43+
../../../vendor/bin/phpunit
44+
```
45+
46+
47+
## Contributing
48+
49+
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
50+
51+
## Security
52+
53+
If you discover any security related issues, please email fs@integer-net.de instead of using the issue tracker.
54+
55+
## Credits
56+
57+
- [Willem Wigman][link-author]
58+
- [Fabian Schmengler][link-author2]
59+
- [All Contributors][link-contributors]
60+
61+
## License
62+
63+
The MIT License (MIT). Please see [License File](LICENSE.txt) for more information.
64+
65+
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
66+
[ico-travis]: https://img.shields.io/travis/integer-net/magento2-session-unblocker/master.svg?style=flat-square
67+
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/integer-net/magento2-session-unblocker.svg?style=flat-square
68+
[ico-code-quality]: https://img.shields.io/scrutinizer/g/integer-net/magento2-session-unblocker.svg?style=flat-square
69+
70+
[link-packagist]: https://packagist.org/packages/integer-net/magento2-session-unblocker
71+
[link-travis]: https://travis-ci.org/integer-net/magento2-session-unblocker
72+
[link-scrutinizer]: https://scrutinizer-ci.com/g/integer-net/magento2-session-unblocker/code-structure
73+
[link-code-quality]: https://scrutinizer-ci.com/g/integer-net/magento2-session-unblocker
74+
[link-author]: https://github.com/wigman
75+
[link-author2]: https://github.com/schmengler
76+
[link-contributors]: ../../contributors

0 commit comments

Comments
 (0)