-
Notifications
You must be signed in to change notification settings - Fork 560
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: baseline all the templated markdown docs (#597)
- Loading branch information
childish-sambino
authored
Jan 17, 2020
1 parent
e1ea30f
commit e598f23
Showing
4 changed files
with
118 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# 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 both within project spaces and in public spaces | ||
when an individual is representing the project or its community. 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,14 @@ | ||
*Note: These issues are for bugs and feature requests for the helper libraries. | ||
If you need help or support, please email [email protected] and one of our experts | ||
will assist you!* | ||
<!-- | ||
If this is a feature request, make sure you search Issues for an existing request before creating a new one! | ||
--> | ||
|
||
### Issue Summary | ||
A summary of the issue and the environment in which it occurs. If suitable, include the steps required to reproduce the bug. Please feel free to include screenshots, screencasts, or code examples. | ||
|
||
**Version:** | ||
### Steps to Reproduce | ||
1. This is the first step | ||
2. This is the second step | ||
3. Further steps, etc. | ||
|
||
### Code Snippet | ||
```php | ||
|
@@ -12,15 +17,10 @@ will assist you!* | |
|
||
### Exception/Log | ||
``` | ||
<place exception/log here> | ||
# paste exception/log here | ||
``` | ||
|
||
### Steps to Reproduce | ||
1. | ||
2. | ||
3. | ||
|
||
### Technical details: | ||
* twilio-php version: | ||
* php version: | ||
|
||
### Feature Request | ||
_If this is a feature request, make sure you search Issues for an existing | ||
request before creating a new one!_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
<!-- | ||
We appreciate the effort for this pull request but before that please make sure you read the contribution guidelines, then fill out the blanks below. | ||
Please format the PR title appropriately based on the type of change: | ||
<type>[!]: <description> | ||
Where <type> is one of: docs, chore, feat, fix, test. | ||
Add a '!' after the type for breaking changes (e.g. feat!: new breaking feature). | ||
**All third-party contributors acknowledge that any contributions they provide will be made under the same open-source license that the open-source project is provided under.** | ||
Please enter each Issue number you are resolving in your PR after one of the following words [Fixes, Closes, Resolves]. This will auto-link these issues and close them when this PR is merged! | ||
e.g. | ||
Fixes #1 | ||
Closes #2 | ||
--> | ||
|
||
# Fixes # | ||
|
||
A short description of what this PR does. | ||
|
||
### Checklist | ||
- [ ] I acknowledge that all my contributions will be made under the project's license | ||
- [ ] I have made a material change to the repo (functionality, testing, spelling, grammar) | ||
- [ ] I have read the [Contribution Guidelines](CONTRIBUTING.md) and my PR follows them | ||
- [ ] I have titled the PR appropriately | ||
- [ ] I have updated my branch with the master branch | ||
- [ ] I have added tests that prove my fix is effective or that my feature works | ||
- [ ] I have added necessary documentation about the functionality in the appropriate .md file | ||
- [ ] I have added inline documentation to the code I modified | ||
|
||
If you have questions, please file a [support ticket](https://twilio.com/help/contact), or create a GitHub Issue in this repository. |