_Contributing

How to contribute

This page is a reminder and guide for future TAs who would like to contribute to the development of the course.

If you read this page, you probably want to make updates and changes to the course material. You can do this by making a local copy of this repository and running the page in your machine. You can find the full tutorial here: https://carpentries.github.io/lesson-example/index.html

I'll try to summarize the steps here:

1. Make sure to have a UNIX environment to work with. If you have a windows, you can use the Windows Subsystem for Linux. I also use VS Code to help me with daily tasks.
2. As a prerequisite, you might want to learn about working in UNIX environment and basic git. I took this course at the beginning of my PhD and its really helpful. Nevertheless, there are many resources and tutorials out there.
3. When you have your environment ready, you can start by:
   • Installing Ruby. I use rbenv. The lesson will be rendered as github-page, so make sure to install which Ruby version are required: https://pages.github.com/versions/.
   • Make a clone of the repo. Clone and start a local server by:

git clone [email protected]:matinnuhamunada/27255_week_11.git
cd 27255_week_11
make serve
# a local server will be started in http://127.0.0.1:4000

• Start making edits. Read again in the carpentry tutorial for which file to edit, but mainly its: index.md, setup.md, config.yaml, and files in the _episodes folder.