Skip to content

Commit 6114ec3

Browse files
Merge pull request #47 from paultheastronomer/master
Updated info on how to contribute
2 parents 79408b1 + 6236896 commit 6114ec3

File tree

3 files changed

+18
-8
lines changed

3 files changed

+18
-8
lines changed

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe
3434

3535
## Enforcement
3636

37-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at paultheastronomer@protonmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at info@astro4dev.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
3838

3939
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
4040

CONTRIBUTING.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,27 @@
11
Contributing to the Astronomy & Data Science Toolkit
22
===================
33

4+
The toolkit is in its infancy and for it to be a success we need people to help us create and share content. We are always looking for people keen on contributing. The contribution process is a three step process:
5+
6+
1. Content is added to our [repository on GitHub](https://github.com/astro4dev/OAD-Data-Science-Toolkit) or it is sent to us directly via email to info@astro4dev.org.
7+
2. The content is verified by the community or by the OAD Data Science Working Group. You can either create a pull request, or we can create one for you if you are not familiar with using GitHub.
8+
3. Once the content is on GitHub somebody from the OAD Data Science Working Group will add the new entry to our database so that it is available on the [toolkit search page](https://datascience.astro4dev.org/toolkit.php).
9+
10+
# Ways of contributing.
11+
Below are a list of ways to contribute. These are meant to be taken as suggestions.
12+
413
## Teaching materials
5-
If you have ever taught astronomy using data science techniques or you are a data scientist who has used astronomy examples to teach data science, please consider sharing your teaching materials. You can either directly contribute to github or send us the materials directly via email.
14+
If you have ever taught astronomy using data science techniques or you are a data scientist who has used astronomy examples to teach data science, please consider sharing your teaching materials. You can either directly contribute to GitHub or send us the materials directly via email to info@astro4dev.org.
615

716
## Assessments
8-
Few Astronomy summer schools and extra-curricular programmes use any form of assessment. This deprives students of the opportunity to both experience and demonstrate their achievements; and doesn't allow the ability to show others that they achieved what they intended. The toolkit strives towards providing high quality pre- and post-assessments.
17+
Few Astronomy summer schools and extra-curricular programmes use any form of assessment. This deprives students of the opportunity to both experience and demonstrate their achievements; and doesn't allow the ability to show others that they achieved what they intended. The toolkit strives towards providing high quality pre- and post-assessments. Please share any assessments you have with us.
918

1019
## Coding and Content
11-
This website has been created using a lot of different tools: HTML5, CSS3, PHP, MySQL, AJAX, jQuery, Shell, JavaScript and Python. If you have experience in any of these tools or perhaps would like to improve the content on this website please help contribute. The entire website can be found here.
20+
This website has been created using a lot of different tools: HTML5, CSS3, PHP, MySQL, AJAX, jQuery, Shell, JavaScript and Python. If you have experience in any of these tools or perhaps would like to improve the content on this website please help contribute. The files for the entire website can be found [here](https://github.com/astro4dev/toolkit_website). Current suggestions / issues can be found [here](https://github.com/astro4dev/toolkit_website/issues).
21+
22+
----------
1223

13-
# How to upload content
24+
# How to upload content via GitHub
1425

1526
## Get a GitHub account
1627

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,14 @@ More specifically, the toolkit will provide
1212
- A high quality teaching resources and assessments, for student- and self-assessment.
1313
- Instructors with easily accessible guidance and further information on how to teach effectively and inclusively.
1414

15-
<p align="center"><font size="18"><a href="https://github.com/astro4dev/OAD-Data-Science-Toolkit/tree/master/Teaching%20Materials">Get Started</a></font></p>
16-
1715
## Help contribute
18-
We are looking for contributors who are willing to share their teaching materials. In particular, we are looking for teaching materials which use astronomical examples to teach data science concepts. Simply fork the repository, add your content and create a pull request. If you have material, but don't know how to contribute your work on github, please feel free to check out <a href="https://guides.github.com/activities/forking/" target="_blank">this guide</a> or contact <a href="https://www.paulanthonywilson.com/contact/" target="_blank">Dr. Paul A. Wilson</a> for help.
16+
We are looking for contributors who are willing to share their teaching materials. In particular, we are looking for teaching materials which use astronomical examples to teach data science concepts. Simply fork the repository, add your content and create a pull request. If you have material, but don't know how to contribute your work on github, please feel free to check out [this guide](CONTRIBUTING.md) or contact <a href="https://www.paulanthonywilson.com/contact/" target="_blank">Dr. Paul A. Wilson</a> for help. Contributors are to adhere to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).
1917

2018
## Contributors to the github repository
2119

2220
- <a href="https://www.paulanthonywilson.com/" target="_blank">Dr. Paul A. Wilson</a>, <a href="http://www.astro4dev.org/" target="_blank">OAD, SA</a>
2321
- <a href="http://vanessa.saao.ac.za" target="_blank">Dr. Vanessa McBride</a>, <a href="http://www.astro4dev.org/" target="_blank">OAD, SA</a>
22+
- <a href="https://brucellino.github.io/" target="_blank">Dr. Bruce Becker</a>, <a href="https://www.csir.co.za/meraka" target="_blank">Meraka Institute, CSIR, SA</a>
2423
- <a href="https://github.com/ArunAniyan" target="_blank">Dr. Arun Aniyan</a>, <a href="http://www.ska.ac.za/" target="_blank">SKA South Africa</a>
2524
- <a href="http://webusers.astro.umn.edu/%7Ebrown/" target="_blank">Dr. Shea Brown</a>, <a href="https://uiowa.edu/" target="_blank">University of Iowa, USA</a>
2625
- <a href="https://github.com/sfebruary" target="_blank">Dr. Sean February</a>, <a href="https://www.chpc.ac.za/" target="_blank">CHPC, SA</a>

0 commit comments

Comments
 (0)