Skip to content

Commit e3908a0

Browse files
author
childish-sambino
authored
docs: baseline all the templated markdown docs (#504)
1 parent 56c2b99 commit e3908a0

File tree

4 files changed

+118
-14
lines changed

4 files changed

+118
-14
lines changed

‎CODE_OF_CONDUCT.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributor Covenant 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 making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org

‎ISSUE_TEMPLATE.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1-
*Note: These issues are for bugs and feature requests for the helper libraries.
2-
If you need help or support, please email [email protected] and one of our experts
3-
will assist you!*
1+
<!--
2+
If this is a feature request, make sure you search Issues for an existing request before creating a new one!
3+
-->
44

5+
### Issue Summary
6+
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.
57

6-
**Version:**
8+
### Steps to Reproduce
9+
1. This is the first step
10+
2. This is the second step
11+
3. Further steps, etc.
712

813
### Code Snippet
914
```python
@@ -12,15 +17,10 @@ will assist you!*
1217

1318
### Exception/Log
1419
```
15-
<place exception/log here>
20+
# paste exception/log here
1621
```
1722

18-
### Steps to Reproduce
19-
1.
20-
2.
21-
3.
22-
23+
### Technical details:
24+
* twilio-python version:
25+
* python version:
2326

24-
### Feature Request
25-
_If this is a feature request, make sure you search Issues for an existing
26-
request before creating a new one!_

‎LICENSE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
21+
SOFTWARE.

‎PULL_REQUEST_TEMPLATE.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!--
2+
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.
3+
4+
Please format the PR title appropriately based on the type of change:
5+
<type>[!]: <description>
6+
Where <type> is one of: docs, chore, feat, fix, test.
7+
Add a '!' after the type for breaking changes (e.g. feat!: new breaking feature).
8+
9+
**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.**
10+
11+
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!
12+
e.g.
13+
Fixes #1
14+
Closes #2
15+
-->
16+
17+
# Fixes #
18+
19+
A short description of what this PR does.
20+
21+
### Checklist
22+
- [ ] I acknowledge that all my contributions will be made under the project's license
23+
- [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
24+
- [ ] I have read the [Contribution Guidelines](CONTRIBUTING.md) and my PR follows them
25+
- [ ] I have titled the PR appropriately
26+
- [ ] I have updated my branch with the master branch
27+
- [ ] I have added tests that prove my fix is effective or that my feature works
28+
- [ ] I have added necessary documentation about the functionality in the appropriate .md file
29+
- [ ] I have added inline documentation to the code I modified
30+
31+
If you have questions, please file a [support ticket](https://twilio.com/help/contact), or create a GitHub Issue in this repository.

0 commit comments

Comments
 (0)