-
Notifications
You must be signed in to change notification settings - Fork 21
/
CONTRIBUTING.md
85 lines (60 loc) · 4.91 KB
/
CONTRIBUTING.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
Contributing to the Astronomy & Data Science Toolkit
===================
<p align="center"><img src="https://raw.githubusercontent.com/astro4dev/OAD-Data-Science-Toolkit/master/img/DST_logo_250px.png" alt="DST Logo"/></p>
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:
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.
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.
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).
# Ways of contributing.
Below are a list of ways to contribute. These are meant to be taken as suggestions.
## Teaching materials
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.
## Assessments
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.
## Translations
In our attempt at making the toolkit accessible to as many people as possible, we have decided to support multiple languages. To translate the website itself, fork the [website repository](https://github.com/astro4dev/toolkit_website) and change the text to the language you wish to translate too. More on how to do translations [here](https://github.com/astro4dev/toolkit_website).
## Coding and Content
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).
----------
# How to upload content via GitHub
## Get a GitHub account
It's required if you want to submit content to the toolkit which is hosted on GitHub. Get an account <a href="https://github.com/" target="_blank">here</a>.
## Install git on your computer
To use Git on the command line, you'll need to download, install, and configure Git on your computer.
On Ubuntu
```sh
sudo apt-get install git
```
There is also a GUI interface known as the
<a href="https://desktop.github.com/" target="_blank">Desktop version</a> which is available for Windows and for Mac OSX.
## Fork a repository
<a href="https://help.github.com/articles/fork-a-repo/" target="_blank">Instructions on GitHub</a>
## Syncing a fork
If you have previously forked the repository, but it is now 'out of date' you may wish to bring your fork up to date with the main repository. You can find instructions on how to sync a fork <a href="https://help.github.com/articles/syncing-a-fork/" target="_blank">here</a>.
## Making changes
Download all the latest changes to your local repository
```sh
git pull
```
Once you have made changes locally you can get an overview of the files you've alterned (relative to your online repository) by typing:
```sh
git status
```
Red coloured files means they have not been added. Green means they have.
To push a file to your repository clone on github type in any directory (within the
OAD-Data-Science-Toolkit folder):
```sh
git add [name_of_file]
```
You then have to commit it (basically prepare it to be uploaded) by adding a comment describing what you did:
```sh
git commit -m 'I removed the bug causing...'
```
Finally push it to your online clone of the repository by typing:
```sh
git push
```
## Opening pull requests
If you are hoping to contribute back to the original repository, you can send a request to the original author to pull your fork into their repository by submitting a <a href="https://help.github.com/articles/about-pull-requests/" target="_blank">pull request</a>.
## Making the content available on the toolkit website
Once the content is on github, sombody from the OAD Data Science Working Group will add the content to the website making it searchable. See [here](How_the_toolkit_works.md) for more info.