8000 add contributing docs (#182) · Raptorly1/client-python@82a8a93 · GitHub
[go: up one dir, main page]
Skip to content

Commit 82a8a93

Browse files
author
clickingbuttons
authored
add contributing docs (polygon-io#182)
1 parent ccbeb62 commit 82a8a93

File tree

3 files changed

+73
-0
lines changed

3 files changed

+73
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
<!---
12+
A clear and concise description of what the bug is.
13+
-->
14+
15+
**To Reproduce**
16+
<!---
17+
Steps to reproduce the behavior:
18+
1. Go to '...'
19+
2. Click on '....'
20+
3. Scroll down to '....'
21+
4. See error
22+
-->
23+
24+
**Expected behavior**
25+
<!---
26+
A clear and concise description of what you expected to happen.
27+
-->
28+
29+
**Screenshots**
30+
<!---
31+
If applicable, add screenshots to help explain your problem.
32+
-->
33+
34+
**Additional context**
35+
<!---
36+
Add any other context about the problem here.
37+
-->

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
<!---
12+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13+
-->
14+
15+
**Describe the solution you'd like**
16+
<!---
17+
A clear and concise description of what you want to happen.
18+
-->
19+
20+
**Describe alternatives you've considered**
21+
<!---
22+
A clear and concise description of any alternative solutions or features you've considered.
23+
-->
24+
25+
**Additional context**
26+
<!---
27+
Add any other context or screenshots about the feature request here.
28+
-->

‎README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,11 @@ Requires Python >= 3.8.
1414
## Getting started
1515
See the [Getting Started](https://polygon-api-client.readthedocs.io/en/latest/Getting-Started.html)
1616
section in our docs or view the [examples](./examples) directory.
17+
18+
# Contributing
19+
20+
For now, we're generally not accepting pull requests from outside contributors
21+
but we're open to bug reports and feature requests. Or if you have more general
22+
feedback, feel free to reach out on
23+
our [Slack channel](https://polygon.io/contact).
24+

0 commit comments

Comments
 (0)
0