Skip to content

Commit 79408b1

Browse files
Merge pull request #44 from paultheastronomer/master
Added info on how to contribute
2 parents 8a20206 + cb9492a commit 79408b1

2 files changed

Lines changed: 69 additions & 61 deletions

File tree

CONTRIBUTING.md

Lines changed: 69 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,69 @@
1-
To be added.
1+
Contributing to the Astronomy & Data Science Toolkit
2+
===================
3+
4+
## 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.
6+
7+
## 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.
9+
10+
## 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.
12+
13+
# How to upload content
14+
15+
## Get a GitHub account
16+
17+
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>.
18+
19+
## Install git on your computer
20+
To use Git on the command line, you'll need to download, install, and configure Git on your computer.
21+
22+
On Ubuntu
23+
```sh
24+
sudo apt-get install git
25+
```
26+
27+
There is also a GUI interface known as the
28+
<a href="https://desktop.github.com/" target="_blank">Desktop version</a> which is available for Windows and for Mac OSX.
29+
30+
## Fork a repository
31+
<a href="https://help.github.com/articles/fork-a-repo/" target="_blank">Instructions on GitHub</a>
32+
33+
## Syncing a fork
34+
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>.
35+
36+
## Making changes
37+
38+
Download all the latest changes to your local repository
39+
```sh
40+
git pull
41+
```
42+
43+
Once you have made changes locally you can get an overview of the files you've alterned (relative to your online repository) by typing:
44+
```sh
45+
git status
46+
```
47+
Red coloured files means they have not been added. Green means they have.
48+
49+
To push a file to your repository clone on github type in any directory (within the
50+
OAD-Data-Science-Toolkit folder):
51+
```sh
52+
git add [name_of_file]
53+
```
54+
55+
You then have to commit it (basically prepare it to be uploaded) by adding a comment describing what you did:
56+
```sh
57+
git commit -m 'I removed the bug causing...'
58+
```
59+
60+
Finally push it to your online clone of the repository by typing:
61+
```sh
62+
git push
63+
```
64+
65+
## Opening pull requests
66+
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>.
67+
68+
## Making the content available on the toolkit website
69+
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.

How_to_upload_content.md

Lines changed: 0 additions & 60 deletions
This file was deleted.

0 commit comments

Comments
 (0)