Skip to content
This repository was archived by the owner on Apr 22, 2020. It is now read-only.

Commit b7b01f3

Browse files
committed
Docs: Add code of conduct and contributing docs
1 parent bcd0b8a commit b7b01f3

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
This project is governed by the Contributor Covenant version 1.4
2+
(https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).
3+
All contributors and participants agree to abide by its terms.
4+
To report violations, send an email to pedroamador [DOT] rodriguez [AT] gmail [DOT] com

CONTRIBUTING.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contributing guide
2+
3+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
4+
5+
- Reporting a bug
6+
- Discussing the current state of the code
7+
- Submitting a fix
8+
- Proposing new features
9+
- Becoming a maintainer
10+
11+
## We Develop with Github
12+
13+
We use github to host code, to track issues and feature requests, as well as accept pull requests.
14+
15+
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
16+
17+
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:
18+
19+
1. Fork the repo and create your branch from `master`.
20+
2. If you've added code that should be tested, add tests.
21+
3. If you've changed APIs, update the documentation.
22+
4. Ensure the test suite passes.
23+
5. Make sure your code lints.
24+
6. Issue that pull request!
25+
26+
## Any contributions you make will be under the MIT Software License
27+
28+
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.
29+
30+
## Report bugs using Github's issues
31+
32+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/tpbtools/gp-php/issues/new); it's that easy!
33+
34+
## Write bug reports with detail, background, and sample code
35+
36+
**Great Bug Reports** tend to have:
37+
38+
- A quick summary and/or background
39+
- Steps to reproduce
40+
- Be specific!
41+
- Give sample code if you can
42+
- What you expected would happen
43+
- What actually happens
44+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
45+
46+
## License
47+
48+
By contributing, you agree that your contributions will be licensed under its MIT License.
49+
50+
## References
51+
52+
Based on https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62 adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)

0 commit comments

Comments
 (0)