brief contribution tutorial #3
Conversation
|
This is good. Let's turn the |
|
Bah! I didn't mean to close this... |
…also updated list formatiing.
…also updated list formatiing.
…also updated list formatiing.
|
The contribution tutorial is a bit better formatted and now includes instructions for those using git v1.7.1 (which is evidently the version on our RHEL 6 computers and it's difficult to update due to root access issues.) Sorry for all the tiny commits at the end, I was tweaking the .md file and seeing how it looked online. |
|
@brisbind - thanks for working on this! Will review this. |
| @@ -0,0 +1,158 @@ | |||
| ###I have some code. I just want to add it! How do I do that? | |||
|
|
|||
| radioscripts_contrib is a collection of user-created radio astronomy python scripts. This code is offered with minimal vetting process and without any guarantee of reliability or accuracy. We encourage interested visitors to contribute by adding their own useful python routines. The radioscripts_contrib collection operates out of a Git Hub repository. Below is a very quick and very dirty tutorial on how to contribute your own code to the repository. This will not make you a Git master, but it will let you get the job done. If you're interested in a more in depth look at coordinating public contributed code in a nice controlled manner you may want to check out the Astropy tutorial on contributing code: http://docs.astropy.org/en/latest/development/workflow/development_workflow.html | |||
There was a problem hiding this comment.
It's a good idea to wrap the text to 78 characters so that it is guaranteed to look fine in any text editor
There was a problem hiding this comment.
Also, nice to make things like radioscripts_contrib into links. With rst, that is done by something like
`radioscripts_contrib <https://github.com/radio-tools/radioscripts_contrib>`_
Created first draft of a tutorial on how to contribute code, along with a demo script, helloworld.py. Also updated READMEs to reflect helloworld changes.