You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ATTRIBUTION.rst
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,15 @@
1
1
.. _attribution_ref_label:
2
+
2
3
Attribution Guidelines
3
4
======================
4
5
5
6
We are extremely grateful to everyone who has contributed to the success of the icepyx community, whether through direct contributions to or feedback about icepyx or as developers or maintainers of complimentary resources that are included within the icepyx ecosystem. This document outlines our goals to give appropriate attribution to all contributors to icepyx in ways that are fair and diverse and supportive of professional goals. To do so, we define broadly *contributions* as:
6
7
7
8
Efforts towards achieving icepyx's goals, including writing code, tests, or documentation,
8
-
development of example workflows, development, significant contributions, or maintenance of
9
-
a tailored package that broadens the functionality of icepyx, feedback and suggestions,
9
+
development of example workflows, development, significant contributions, or maintenance of
10
+
a tailored package that broadens the functionality of icepyx, feedback and suggestions,
10
11
community building, etc.
11
-
12
+
12
13
We use the terms "contributors", "developers", and "authors" interchangeably. We will recognize contributions in the following ways.
13
14
14
15
Contributors List
@@ -39,11 +40,11 @@ Authorship on scientific papers currently constitutes an important metric for as
39
40
2. Add themself to the `Contributors List`_.
40
41
3. Contribute ideas, participate in authorship discussions (see next paragraph), write, read, and review the manuscript in a timely manner, and provide feedback (acknowledgement of review is sufficient, but we'd prefer more).
41
42
42
-
Author order will be determined based on co-author discussion, led by the lead author, during the initial planning stages of manuscript preparation (i.e. as soon as an idea matures into a potential manuscript and before writing begins). Authorship will continue to be evaluated throughout the manuscript preparation process. Discussions will consider authorship norms (e.g. How does author order convey participation and prestige? How critical is first authorship to career advancement for each member of the team? Do an individual's contributions meet authorship criteria or are they more suited to acknowledgements?). Author order determination will also consider metrics such as the number of commits since the last major release with an associated paper (``git shortlog vX.0.0...HEAD -sne``), contributions that do not have associated commits, and contributions to the preparation of the manuscript.
43
+
Author order will be determined based on co-author discussion, led by the lead author, during the initial planning stages of manuscript preparation (i.e. as soon as an idea matures into a potential manuscript and before writing begins). Authorship will continue to be evaluated throughout the manuscript preparation process. Discussions will consider authorship norms (e.g. How does author order convey participation and prestige? How critical is first authorship to career advancement for each member of the team? Do an individual's contributions meet authorship criteria or are they more suited to acknowledgements?). Author order determination will also consider metrics such as the number of commits since the last major release with an associated paper (``git shortlog vX.0.0...HEAD -sne``), contributions that do not have associated commits, and contributions to the preparation of the manuscript.
43
44
44
45
45
46
46
-
Disclaimer: These policies are not permanent or fixed and may change to accomodate community growth,
47
+
Disclaimer: These policies are not permanent or fixed and may change to accomodate community growth,
47
48
best practices, and feedback.
48
49
49
-
Copyright notice: This document was inspired by the `authorship guidelines <https://github.com/fatiando/contributing/blob/master/AUTHORSHIP.md>`_ provided by `Fatiando a Terra <https://github.com/fatiando>`_ and encourages potential co-authors to consider the resources provided by the `NASA High Mountain Asia Team (HiMAT) <https://highmountainasia.github.io/team-collaboration/authorship/>`_.
50
+
Copyright notice: This document was inspired by the `authorship guidelines <https://github.com/fatiando/contributing/blob/master/AUTHORSHIP.md>`_ provided by `Fatiando a Terra <https://github.com/fatiando>`_ and encourages potential co-authors to consider the resources provided by the `NASA High Mountain Asia Team (HiMAT) <https://highmountainasia.github.io/team-collaboration/authorship/>`_.
Copy file name to clipboardExpand all lines: doc/source/community/contact.rst
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,5 @@
1
1
.. _contact_ref_label:
2
+
2
3
Contact Us
3
4
==========
4
5
@@ -20,4 +21,4 @@ We meet on:
20
21
21
22
Additional information about logging in to the meetings can be found on `this Discourse post <https://discourse.pangeo.io/t/icepyx-team-meetings/722/2?u=jessicas11>`_.
22
23
23
-
Absolutely NO previous software development experience is necessary to attend any meeting. Think of them more like coffee hour mixed with office hours than a conference call. We look forward to seeing you there!
24
+
Absolutely NO previous software development experience is necessary to attend any meeting. Think of them more like coffee hour mixed with office hours than a conference call. We look forward to seeing you there!
This June 2019 event resulted in the production of a series of `tutorials <https://github.com/ICESAT-2HackWeek/ICESat2_hackweek_tutorials>`_, developed primarily by members of the ICESat-2 Science Team and early data users, aimed at educating the cryospheric community in obtaining and using ICESat-2 datasets. During the actual Hackweek, teams of researchers and data scientists developed a series of interesting `projects <https://github.com/ICESAT-2HackWeek/projects_2019>`_ related to their interests/research.
15
+
This June 2019 event resulted in the production of a series of `tutorials <https://github.com/ICESAT-2HackWeek/ICESat2_hackweek_tutorials>`_, developed primarily by members of the ICESat-2 Science Team and early data users, aimed at educating the cryospheric community in obtaining and using ICESat-2 datasets. During the actual Hackweek, teams of researchers and data scientists developed a series of interesting `projects <https://github.com/ICESAT-2HackWeek/projects_2019>`_ related to their interests/research.
15
16
16
17
The available tutorials, most of which contain one or more Jupyter Notebooks to illustrate concepts, are listed below. Additional information for citing (including licensing) and running (e.g. through a Pangeo Binder) these tutorials can be found at the above link.
17
18
@@ -91,7 +92,7 @@ Here we describe a selection of publicly available Python code posted on GitHub
Copy file name to clipboardExpand all lines: doc/source/contributing/contribution_guidelines.rst
+7-3Lines changed: 7 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,11 @@ We are delighted you'd like to contribute your `icepyx <https://github.com/icesa
51
51
52
52
Contributing Code
53
53
-----------------
54
-
We follow a standard git workflow for code changes and additions. All submitted code, including our own, goes through the pull request process; no changes are pushed directly to the *master* or *development* branches. This allows our continuous integration (testing) process to ensure that the code is up to our standards and passes all of our tests (i.e. doesn't break what's already there and working). By having a *development* branch for daily work, we enable the *master* branch to remain stable between releases even as new features are being added.
54
+
We follow a standard git workflow for code changes and additions.
55
+
All submitted code, including our own, goes through the pull request process;
56
+
no changes are pushed directly to the *main* or *development* branches.
57
+
This allows our continuous integration (testing) process to ensure that the code is up to our standards and passes all of our tests (i.e. doesn't break what's already there and working).
58
+
By having a *development* branch for daily work, we enable the *main* branch to remain stable between releases even as new features are being added.
55
59
56
60
First Steps
57
61
^^^^^^^^^^^
@@ -77,7 +81,7 @@ We encourage users to follow the `git pull request workflow <https://www.asmeure
77
81
- Fork the repo to your personal GitHub account
78
82
- Add your fork as a remote
79
83
- Add yourself to `CONTRIBUTORS.rst` (see `Attribution for Contributions`_)
80
-
84
+
81
85
(each time you are going to make changes)
82
86
83
87
- Update the development branch
@@ -101,4 +105,4 @@ Discovered a currently untested case? Please share your test, either by creating
101
105
102
106
Attribution for Contributions
103
107
-----------------------------
104
-
We appreciate any and all contributions made to icepyx, direct or indirect, large or small. To learn more about how you will be recognized for your contributions, please see our :ref:`Attribution Guidelines <attribution_ref_label>`.
108
+
We appreciate any and all contributions made to icepyx, direct or indirect, large or small. To learn more about how you will be recognized for your contributions, please see our :ref:`Attribution Guidelines <attribution_ref_label>`.
0 commit comments