Skip to content

Commit

Permalink
Update contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
larrybradley committed Nov 15, 2023
1 parent 084ff03 commit ebf1efa
Showing 1 changed file with 9 additions and 16 deletions.
25 changes: 9 additions & 16 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ Reporting Issues

If you have found a bug, please report it by creating
a new issue on the `Regions GitHub issue tracker
<https://github.com/astropy/regions/issues>`_. That requires creating a
`free Github account <https://github.com/>`_ if you do not have one.
<https://github.com/astropy/regions/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. You may be also asked to
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.
Please include a minimal example that demonstrates the issue and will
allow the developers to reproduce and fix the problem. You may be also
asked to 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
Expand All @@ -26,12 +26,5 @@ welcome contributors who will abide by the `Python Software Foundation
Code of Conduct <https://www.python.org/psf/conduct/>`_.

This package 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://docs.astropy.org/en/latest/development/workflow/development_workflow.html>`_

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

* `Developer Documentation <https://docs.astropy.org/en/latest/development/index.html>`_
`Astropy`_. Please read the `Astropy Development documentation
<https://docs.astropy.org/en/latest/index_dev.html>`_ to get started.

0 comments on commit ebf1efa

Please sign in to comment.