Skip to content

Commit

Permalink
Add Discussions to CONTRIBUTING.md, add issue config
Browse files Browse the repository at this point in the history
  • Loading branch information
KostyaEsmukov committed Dec 26, 2020
1 parent bf5d33c commit b46f353
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 7 deletions.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
blank_issues_enabled: true # default
contact_links:
- name: 🙏 Stack Overflow
url: https://stackoverflow.com/questions/tagged/geopy
about: |
If you have a usage question or an error rather than a specific
bug report, Stack Overflow might be the better place for that.
There's a somewhat active community here so you will probably get
a solution quicker. And also there is a large amount of already
resolved questions which can help too! Just remember to put the `geopy`
tag if you'd decide to open a question.
- name: 💬 Discussions
url: https://github.com/geopy/geopy/discussions
about: |
GitHub Discussions is
a good place to start if Stack Overflow didn't help or you have
some idea or a feature request you'd like to bring up, or if you
just have trouble and not sure you're doing everything right.
Solutions and helpful snippets/patterns are also very welcome here.
- name: 📝 Contributing policy
url: https://github.com/geopy/geopy/blob/master/CONTRIBUTING.md
about: |
See CONTRIBUTING.md for more details on how issues and PRs
are handled in geopy.
33 changes: 27 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,33 @@

## Reporting issues

- Please note that the issue tracker is not for questions. Use Stack Overflow
instead. Make sure to tag your question with
[geopy](https://stackoverflow.com/questions/tagged/geopy) tag.

- If possible, before submitting an issue report try to verify that the issue
haven't already been fixed and is not a duplicate.
If you caught an exception from geopy please try to Google the error first.
There is a great chance that it has already been discussed somewhere
and solutions have been provided (usually on GitHub or on Stack Overflow).

Before reporting an issue please ensure that you have tried
to get the answer from the doc: https://geopy.readthedocs.io/.

Keep in mind that if a specific geocoding service's API is not behaving
correctly then it probably won't be helpful to report that issue
here, see https://geopy.readthedocs.io/en/latest/#geopy-is-not-a-service

The following resources are available for your input:

1. Stack Overflow with [geopy tag](https://stackoverflow.com/questions/tagged/geopy).
There's a somewhat active community here so you will probably get
a solution quicker. And also there is a large amount of already
resolved questions which can help too! Just remember to put the `geopy`
tag if you'd decide to open a question.
1. [GitHub Discussions](https://github.com/geopy/geopy/discussions) is
a good place to start if Stack Overflow didn't help or you have
some idea or a feature request you'd like to bring up, or if you
just have trouble and not sure you're doing everything right.
Solutions and helpful snippets/patterns are also very welcome here.
1. [GitHub Issues](https://github.com/geopy/geopy/issues) should only
be used for definite bug reports and specific tasks. If you're not sure
whether your issue fits this then please start with Discussions
first.


## Submitting patches
Expand Down
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ Welcome to GeoPy's documentation!

:Documentation: https://geopy.readthedocs.io/
:Source Code: https://github.com/geopy/geopy
:Issue Tracker: https://github.com/geopy/geopy/issues
:Stack Overflow: https://stackoverflow.com/questions/tagged/geopy
:Discussions: https://github.com/geopy/geopy/discussions
:Issue Tracker: https://github.com/geopy/geopy/issues
:PyPI: https://pypi.org/project/geopy/

.. automodule:: geopy
Expand Down

0 comments on commit b46f353

Please sign in to comment.