Skip to content

Commit cfa436e

Browse files
authored
Merge branch 'main' into galaxyq
2 parents 8410f33 + 6f54d1f commit cfa436e

File tree

2 files changed

+88
-11
lines changed

2 files changed

+88
-11
lines changed

CONTRIBUTING.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,45 @@
11
Contributor Guidelines
22
======================
33

4+
How to contribute
5+
-----------------
6+
We love contributions! SkyPy is open source,
7+
built on open source, and we'd love to have you hang out in our community.
8+
Whether you would like to contribute to SkyPy with your own piece of code or
9+
helping develop a concrete feature in SkyPy:
10+
11+
1. Read through our `Discussions Page`_ to start a new conversation and share your
12+
ideas or follow up an existing conversation on a particular feature.
13+
14+
2. Following the discussions, when you have a good idea of the specifics
15+
of the feature you wish to contribute, open an `Issue`_ describing the feature.
16+
17+
3. Then follow the `Contributor Guidelines`_ on the rest of this page to open
18+
a `Pull Request`_ to contribute the code implementing the new feature.
19+
20+
Members vs External contributions
21+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
22+
23+
SkyPy allows contributions from two types of contributor: *Members* and *External Contributors*.
24+
These two categories are intended to allow contributions both from those who are willing and
25+
able to commit to being part of the SkyPy community and actively involved in the steering of the project,
26+
and those who wish to simply contribute code where a need has been identified.
27+
28+
1. SkyPy *Members* go through a simple onboarding process where their expertise and expected contributions
29+
are discussed and defined. Members have access to internal communication channels, they are involved in
30+
SkyPy decision making processes and attend quarterly meetings.
31+
Members are listed as a separate tier in author lists for SkyPy publications,
32+
with the classification of "Creators" in the Zenodo DoI.
33+
34+
2. *External Contributors* are able to develop, discuss and commit code in the same way as *Members*,
35+
but do not have the same responsibilities and opportunities for contributing to the guidance and management
36+
of SkyPy as a project. *External Contributors* are listed as a separate tier in author lists for SkyPy publications,
37+
with the classification of "Others" in the Zenodo DoI.
38+
39+
.. _Discussions Page: https://github.com/skypyproject/skypy/discussions
40+
.. _Issue: https://github.com/skypyproject/skypy/issues
41+
.. _Pull Request: https://github.com/skypyproject/skypy/pulls
42+
443
GitHub Workflow
544
---------------
645

README.rst

Lines changed: 49 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -61,28 +61,66 @@ Examples_ that demonstrate how to use it.
6161
.. _Examples: https://skypy.readthedocs.io/en/stable/examples/index.html
6262

6363

64-
Get in Touch
64+
Contributing
6565
------------
6666

67-
You are welcome to talk about the SkyPy package and code using our
68-
`Discussions Page`_. For any other questions about the project in general,
69-
please get in touch with the `SkyPy Co-ordinators`_.
67+
We love contributions!
68+
SkyPy is open source,
69+
built on open source, and we'd love to have you hang out in our community.
7070

71-
.. _Discussions Page: https://github.com/skypyproject/skypy/discussions
72-
.. _SkyPy Co-ordinators: mailto:skypy-coordinators@googlegroups.com
71+
How to contribute
72+
^^^^^^^^^^^^^^^^^
7373

74-
Contributing
75-
------------
74+
Whether you would like to contribute to SkyPy with your own piece of code or
75+
helping develop a concrete feature in SkyPy:
7676

77-
We love contributions! SkyPy is open source,
78-
built on open source, and we'd love to have you hang out in our community.
79-
For information on how to contribute see our `Contributor Guidelines`_.
77+
1. Read through our `Discussions Page`_ to start a new conversation and share your
78+
ideas or follow up an existing conversation on a particular feature.
79+
80+
2. Following the discussions, when you have a good idea of the specifics
81+
of the feature you wish to contribute, open an `Issue`_ describing the feature.
82+
83+
3. Then follow the `Contributor Guidelines`_ to open a `Pull Request`_ to contribute
84+
the code implementing the new feature.
85+
86+
For further information on how to contribute see our `Contributor Guidelines`_.
8087
All communication relating to The SkyPy Project must meet the standards set out
8188
in the `Code of Conduct`_.
8289

90+
.. _Issue: https://github.com/skypyproject/skypy/issues
91+
.. _Pull Request: https://github.com/skypyproject/skypy/pulls
8392
.. _Contributor Guidelines: https://skypy.readthedocs.io/en/latest/developer/contributing.html
8493
.. _Code of Conduct: https://skypy.readthedocs.io/en/stable/project/code_of_conduct.html
8594

95+
Members vs External contributions
96+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
97+
98+
SkyPy allows contributions from two types of contributor: *Members* and *External Contributors*.
99+
These two categories are intended to allow contributions both from those who are willing and
100+
able to commit to being part of the SkyPy community and actively involved in the steering of the project,
101+
and those who wish to simply contribute code where a need has been identified.
102+
103+
1. SkyPy *Members* go through a simple onboarding process where their expertise and expected contributions
104+
are discussed and defined. Members have access to internal communication channels, they are involved in
105+
SkyPy decision making processes and attend quarterly meetings.
106+
Members are listed as a separate tier in author lists for SkyPy publications,
107+
with the classification of "Project Members" in the Zenodo DoI.
108+
109+
2. *External Contributors* are able to develop, discuss and commit code in the same way as *Members*,
110+
but do not have the same responsibilities and opportunities for contributing to the guidance and management
111+
of SkyPy as a project. *External Contributors* are listed as a separate tier in author lists for SkyPy publications,
112+
with the classification of "Others" in the Zenodo version DoI.
113+
114+
Get in Touch
115+
------------
116+
117+
You are welcome to talk about the SkyPy package and code using our
118+
`Discussions Page`_. For any other questions about the project in general,
119+
please get in touch with the `SkyPy Co-ordinators`_.
120+
121+
.. _Discussions Page: https://github.com/skypyproject/skypy/discussions
122+
.. _SkyPy Co-ordinators: mailto:skypy-coordinators@googlegroups.com
123+
86124
.. |PyPI| image:: https://img.shields.io/pypi/v/skypy?label=PyPI&logo=pypi
87125
:target: https://pypi.python.org/pypi/skypy
88126

0 commit comments

Comments
 (0)