File: contributing.rst

package info (click to toggle)
ccdproc 2.5.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,132 kB
  • sloc: python: 5,554; makefile: 112
file content (38 lines) | stat: -rw-r--r-- 1,599 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
Reporting Issues and contributing code
======================================

Reporting Issues
----------------

If you have found a bug in ccdproc please report it by creating a
new issue on the `ccdproc GitHub issue tracker
<https://github.com/astropy/ccdproc/issues>`_.  That requires
creating a `free Github account <https://github.com/>`_ if you do not
have one.

Please include an example that demonstrates the issue and will allow the
developers to reproduce and fix the problem, if possible.  You may be asked to
also provide information about your operating system and a full Python stack
trace.  The developers will walk you through obtaining a stack trace if it is
necessary.


Contributing code
-----------------

Like the `Astropy`_ project, `ccdproc <https://ccdproc.rtfd.io>`_ is made both by and for its
users.  We accept contributions at all levels, spanning the gamut from
fixing a typo in the documentation to developing a major new feature.
We welcome contributors who will abide by the `Astropy Code of Conduct
<https://www.astropy.org/code_of_conduct.html>`_.

Ccdproc follows the same workflow and coding guidelines as
`Astropy`_.  The following pages will help you get started with
contributing fixes, code, or documentation (no git or GitHub
experience necessary):

* `How to make a code contribution <https://astropy.readthedocs.io/en/stable/development/workflow/development_workflow.html>`_

* `Coding Guidelines <https://docs.astropy.org/en/latest/development/codeguide.html>`_

* `Developer Documentation <https://docs.astropy.org/en/latest/#developer-documentation>`_