Skip to content

Commit eae005b

Browse files
author
Anton Shabouta
committed
Readme added
1 parent ee88f38 commit eae005b

6 files changed

+233
-0
lines changed

‎CONDUCT.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at `[email protected]`. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

‎CONTRIBUTING.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
We accept contributions via Pull Requests on [Github](https://github.com/phpinnacle/buffer).
6+
7+
8+
## Pull Requests
9+
10+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
11+
12+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
13+
14+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
15+
16+
- **Create feature branches** - Don't ask us to pull from your master branch.
17+
18+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
19+
20+
- **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.
21+
22+
23+
## Running Tests
24+
25+
```bash
26+
$ make test
27+
```
28+
29+
30+
**Happy coding**!

‎ISSUE_TEMPLATE.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## Detailed description
2+
3+
Provide a detailed description of the change or addition you are proposing.
4+
5+
Make it clear if the issue is a bug, an enhancement or just a question.
6+
7+
## Context
8+
9+
Why is this change important to you? How would you use it?
10+
11+
How can it benefit other users?
12+
13+
## Possible implementation
14+
15+
Not obligatory, but suggest an idea for implementing addition or change.
16+
17+
## Your environment
18+
19+
Include as many relevant details about the environment you experienced the bug in and how to reproduce it.
20+
21+
* Version used (e.g. PHP 7.0, PHP 7.1.2):
22+
* Operating system and version (e.g. Ubuntu 16.04, Windows 7):
23+
* Link to your project or gist, code sample
24+
* Other important for issuer reproduce information

‎LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# The MIT License (MIT)
2+
3+
Copyright (c) 2017 PHPinnacle <[email protected]>
4+
5+
> Permission is hereby granted, free of charge, to any person obtaining a copy
6+
> of this software and associated documentation files (the "Software"), to deal
7+
> in the Software without restriction, including without limitation the rights
8+
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
> copies of the Software, and to permit persons to whom the Software is
10+
> furnished to do so, subject to the following conditions:
11+
>
12+
> The above copyright notice and this permission notice shall be included in
13+
> all copies or substantial portions of the Software.
14+
>
15+
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
> THE SOFTWARE.

‎PULL_REQUEST_TEMPLATE.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## Description
2+
3+
Describe your changes in detail.
4+
5+
## Motivation and context
6+
7+
Why is this change required? What problem does it solve?
8+
9+
If it fixes an open issue, please link to the issue here (if you write `fixes #num`
10+
or `closes #num`, the issue will be automatically closed when the pull is accepted.)
11+
12+
## How has this been tested?
13+
14+
Please describe in detail how you tested your changes.
15+
16+
Include details of your testing environment, and the tests you ran to
17+
see how your change affects other areas of the code, etc.
18+
19+
## Types of changes
20+
21+
What types of changes does your code introduce? Put an `x` in all the boxes that apply:
22+
- [ ] Bug fix (non-breaking change which fixes an issue)
23+
- [ ] New feature (non-breaking change which adds functionality)
24+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
25+
26+
## Checklist:
27+
28+
Go over all the following points, and put an `x` in all the boxes that apply.
29+
30+
- [ ] I have read the **[CONTRIBUTING](CONTRIBUTING.md)** document.
31+
- [ ] My pull request addresses exactly one patch/feature.
32+
- [ ] I have created a branch for this patch/feature.
33+
- [ ] Each individual commit in the pull request is meaningful.
34+
- [ ] I have added tests to cover my changes.
35+
- [ ] If my change requires a change to the documentation, I have updated it accordingly.
36+
37+
If you're unsure about any of these, don't hesitate to ask. We're here to help!

‎README.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# PHPinnacle Buffer C Extension
2+
3+
[![Software License][ico-license]](LICENSE.md)
4+
5+
PHPinnacle Buffer C extension trying to speed up [Buffer PHP library](https://github.com/phpinnacle/buffer).
6+
It expose same interface and can be seamlessly integrated.
7+
8+
## Install
9+
10+
```bash
11+
phpize
12+
./configure
13+
make
14+
make install
15+
```
16+
17+
## Basic Usage
18+
19+
Please have a look at main [Buffer PHP library](https://github.com/phpinnacle/buffer) page.
20+
21+
## Testing
22+
23+
```bash
24+
make test
25+
```
26+
27+
## Contributing
28+
29+
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.
30+
31+
## Security
32+
33+
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
34+
35+
## Credits
36+
37+
- [PHPinnacle][link-author]
38+
- [All Contributors][link-contributors]
39+
40+
## License
41+
42+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
43+
44+
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
45+
46+
[link-author]: https://github.com/phpinnacle
47+
[link-contributors]: https://github.com/phpinnacle/ext-buffer/graphs/contributors

0 commit comments

Comments
 (0)