Skip to content

Commit d7af824

Browse files
committed
update and expand contributing guidelines
1 parent 7fa8901 commit d7af824

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

CONTRIBUTING.rst

+14
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,19 @@ As shown in the template_ module, the minimum requirements for a new feature are
4141

4242
PRs will not be accepted if tests fail.
4343

44+
Important Guidelines
45+
--------------------
46+
47+
Astroquery is based on the requests module. All contributions must be based on
48+
the `requests` module and should not use `urllib` or any of the base python url
49+
modules unless there is a demonstrated necessity.
50+
51+
The `requests` module also generally should not be directly used, since the
52+
`astroquery.query.BaseQuery` class, which all astroquery classes should inherit
53+
from, provides access to its own `_request` method. This custom `_request`
54+
method is a wrapper around the `requests.request` function that provides
55+
important astroquery-specific utility, including caching, HTTP header
56+
generation, progressbars, and local writing-to-disk.
57+
4458
.. _astroquery API: docs/api.rst
4559
.. _template: docs/template.rst

0 commit comments

Comments
 (0)