Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated developer documenation #2951

Merged
merged 7 commits into from Mar 20, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
43 changes: 19 additions & 24 deletions CITATION.rst
@@ -1,22 +1,19 @@
*****************************
Acknowledging or Citing SunPy
=============================
*****************************

If you have used SunPy in your scientific work we would appreciate it if you would acknowledge it.
The continued growth and development of SunPy is dependent on the community being aware of the use SunPy.
If you use SunPy, we therefore ask that you acknowledge SunPy appropriately in a publication, presentation, poster, or talk.
The continued growth and development of SunPy is dependent on the community being aware of SunPy.

- **For a publication**, we recommend the following line be added to
the conclusion or acknowledgements:
Publications
============

*This research has made use of SunPy, an open-source and free
community-developed solar data analysis package written in Python
(citation).*
Please add the following line within your methods, conclusion or acknowledgements sections:

The citation is to the `SunPy v0.5 paper`_/`arXiv(open access)`_. If
the journal allows please also include a link to sunpy.org. If you
have the time, please email us to let us know about your paper, as we
maintain a `public list`_ of papers on `Zotero`_. A BibTeX entry for
LaTeX users is:
*This research has made use of SunPy vX.Y, an open-source and free
community-developed solar data analysis Python package (citation).*

The citation should be to the `SunPy paper`_ and the version number should cite the `Zenodo DOI`_ for the version used in your work.

.. code:: bibtex

Expand Down Expand Up @@ -44,17 +41,15 @@ If you use SunPy, we therefore ask that you acknowledge SunPy appropriately in a
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

- **For a poster, talks, or project websites**, please include the
`Sunpy logo`_ on the title, conclusion slide, or about page. For
websites please link the image to `sunpy.org`_. Other versions of the
logo are available in the `sunpy-logo repository`_.
Posters and talks
=================

Thank you, in advance, for your support.
Please include the `Sunpy logo`_ on the title, conclusion slide, or about page.
For websites please link the image to `sunpy.org`_.
Other versions of the logo are available in the `sunpy-logo repository`_.

.. _SunPy v0.5 paper: https://iopscience.iop.org/article/10.1088/1749-4699/8/1/014009
.. _arXiv(open access): https://arxiv.org/abs/1505.02563
.. _public list: https://www.zotero.org/groups/sunpy_-_python_for_solar_physicists
.. _Zotero: https://www.zotero.org/
.. _Sunpy logo: http://sunpy.org/about/#acknowledging
.. _sunpy.org: http://sunpy.org/
.. _SunPy paper: https://iopscience.iop.org/article/10.1088/1749-4699/8/1/014009
.. _Sunpy logo: https://sunpy.org/about/#acknowledging
.. _sunpy.org: https://sunpy.org/
.. _sunpy-logo repository: https://github.com/sunpy/sunpy-logo/
.. _Zenodo DOI: https://doi.org/10.5281/zenodo.591887
108 changes: 40 additions & 68 deletions CODE_OF_CONDUCT.rst
@@ -1,84 +1,56 @@
.. _coc:

***************
Code of Conduct
===============
***************

The SunPy community is made up of members from around the globe with a
diverse set of skills, personalities, and experiences. It is through
these differences that our community experiences success and continued
growth. We expect everyone in our community to follow these guidelines
when interacting with others both inside and outside of our community.
Our goal is to keep ours a positive, inclusive, successful, and growing
community.
The SunPy community is made up of members from around the globe with a diverse set of skills, personalities, and experiences.
It is through these differences that our community experiences success and continued growth.
We expect everyone in our community to follow these guidelines when interacting with others both inside and outside of our community.
Our goal is to keep ours a positive, inclusive, successful, and growing community.

A member of SunPy is:

Open
----
====

Members of the community are open to collaboration, whether on patches,
reporting issues, asking for help or otherwise. We welcome those
interested in joining the community, and realise that including people
with a variety of opinions and backgrounds will only serve to enrich our
community.
Members of the community are open to collaboration, whether on patches, reporting issues, asking for help or otherwise.
We welcome those interested in joining the community, and realise that including people with a variety of opinions and backgrounds will only serve to enrich our community.

We are accepting of all who wish to take part in our activities,
fostering an environment where anyone can participate and everyone can
make a difference, ensuring that all participants are heard and feel
confident that they can freely express their opinions.
We are accepting of all who wish to take part in our activities, fostering an environment where anyone can participate and everyone can make a difference, ensuring that all participants are heard and feel confident that they can freely express their opinions.

Considerate
-----------
===========

Members of the community are considerate of their peers -- other
developers, users, etc. We are thoughtful when addressing the efforts of
others, keeping in mind that often the labour was completed simply for
the good of the community. We are attentive in our communications,
whether in person or online, and we're tactful when approaching
differing views.
Members of the community are considerate of their peers -- other developers, users, etc.
We are thoughtful when addressing the efforts of others, keeping in mind that often the labour was completed simply for the good of the community.
We are attentive in our communications, whether in person or online, and we're tactful when approaching differing views.

We recognise the work made by everyone and ensure the proper
acknowledgement/citation of original authors at all times. As authors,
we pledge to be explicit about how we want our own work to be cited or
acknowledged.
We recognize the work made by everyone and ensure the proper acknowledgement/citation of original authors at all times.
As authors, we pledge to be explicit about how we want our own work to be cited or acknowledged.

Respectful
----------

Members of the community are respectful. We are respectful of others,
their positions, their skills, their commitments, and their efforts. We
are respectful of the volunteer and professional efforts within the
community. We are respectful of the processes set forth in the
community, and we work within them (paying particular attention to those
new to the community).

When we disagree, we are courteous in raising our issues. We provide a
harassment- and bullying-free environment, regardless of sex, sexual
orientation and/or gender identity, disability, physical appearance,
body size, race, nationality, ethnicity, and religion. In particular,
sexual language and imagery, sexist, racist, or otherwise exclusionary
jokes are not appropriate. We will treat those outside our community
with the same respect as people within our community.

Overall, we are good to each other and apply this CoC to all community
situations online and offline, including mailing lists, forums, social
media, conferences, meetings, associated social events, and one-to-one
interactions.

We pledge to help the entire community follow the code of conduct, and
to not remain silent when we see violations of the code of conduct. We
will take action when members of our community violate this code such as
contacting confidential@sunpy.org (all emails sent to this address will
be treated with the strictest confidence) or talking privately with the
person.

Parts of this code of conduct have been adapted from the
`astropy <http://www.astropy.org/about.html>`__ and the `Python Software
Fundation <https://www.python.org/psf/codeofconduct/>`__ codes of
conduct.

--------------

The SunPy Community Code of Conduct is licensed under a Creative Commons
Attribution 4.0 International License. We encourage other communities
related to ours to use or adapt this code as they see fit.
==========

Members of the community are respectful.
We are respectful of others, their positions, their skills, their commitments, and their efforts.
We are respectful of the volunteer and professional efforts within the community.
We are respectful of the processes set forth in the community, and we work within them (paying particular attention to those new to the community).

When we disagree, we are courteous in raising our issues.
We provide a harassment- and bullying-free environment, regardless of sex, sexual orientation, gender identity, disability, physical appearance, body size, race, nationality, ethnicity, and religion.
In particular, sexual language and imagery, sexist, racist, or otherwise exclusionary jokes are not appropriate.
We will treat those outside our community with the same respect as people within our community.

Overall, we are good to each other and apply this code of conduct to all community situations online and offline, including mailing lists, forums, social media, conferences, meetings, associated social events, and one-to-one interactions.

We pledge to help the entire community follow the code of conduct, and to not remain silent when we see violations of the code of conduct.
We will take action when members of our community violate this code such as contacting confidential@sunpy.org (all emails sent to this address will be treated with the strictest confidence) or talking privately with the person.

Parts of this code of conduct have been adapted from the `astropy <http://www.astropy.org/code_of_conduct.html>`__ and the `Python Software Fundation <https://www.python.org/psf/codeofconduct/>`__ codes of conduct.

License
=======

The SunPy Community Code of Conduct is licensed under a Creative Commons Attribution 4.0 International License.
We encourage other communities related to ours to use or adapt this code as they see fit.