Outreachy Applicants: set-up and how-to

Sudha247 commented 2 years ago

To the Outreachy applicants, firstly thanks for your interest in contributing to our project. Below listed are some pointers to help you get started. You are very welcome to ask questions at any step. We'd recommend familiarising yourself with Unix command-line, Git version control and OCaml in that order. Feel free to skip the ones you're already comfortable with.

Unix Command Line

We'll be using Unix command line mainly for running sandmark, it'd be useful to get accustomed to some basic Unix CLI commands. It's recommended to use a Unix based system (Linux or Mac), but it can be done on Windows too with the help of Windows Subsystem for Linux.

Git

The project is hosted on GitHub and we use Git as the version control system. A good introduction to git is here: https://git-scm.com/docs/gittutorial. Note that you're only expected to be familiar with some basic git commands such as git pull, git push, git add, git checkout, git commit.

OCaml

For setting up OCaml, here's a nice guide: https://v3.ocaml.org/docs/up-and-running.

If you are new to OCaml, we'd also recommend the Cornell CS3110 textbook to get a taste of OCaml: https://cs3110.github.io/textbook/cover.html.

Feel free to post below if you need help with setting up OCaml, especially on Windows.

Setting up sandmark

The quick start guide should help you with setting up sandmark in your local machine: https://github.com/ocaml-bench/sandmark#quick-start. The rest of the README file contains information about the various components of sandmark and how they all play together nicely.

How to go from here

Good work on getting the set-up ready!

Issues

Look out for issues in the issue tracker tagged with good first issue. If you'd like to work on an issue, please post a message on the issue stating that you'd line to work on it, along with any questions you might have. Please pick a new one when you see someone has already claimed an issue.

Submitting a PR

Create a fork of sandmark under your GitHub handle, and create a new branch for the current task your working on.
Once you have your changes in place, add only the files you have changed to your commit.
At this point, you are encouraged to do a sequential run on your local machine to ensure the changes don't introduce something unexpected.
Once you've committed the changes to your branch, you can proceed to open a new PR. This will kick-start the CI run which runs a subset of benchmarks to ensure the new changes are working.
- CI is green: Congrats on submitting your patch to sandmark. Please wait for one of mentors to review your PR
- CI is red: The CI showing failures usually means the new changes might be breaking something. But afraid not, the mentors will help you with identifying the source of CI failure. Once that's fixed, code reviews will be made.
  
  Questions

Please feel free to post your questions here in the issue tracker or at #outreachy on OCaml discord.

codeamic commented 2 years ago

Hi Sudha, looking Forward to doing this

Abdulrahim2567 commented 2 years ago

Thanks a lot for the headstart

juliaochoms42 commented 2 years ago

hello everyone i am super excited to be part of this great team looking forward to learn more and also make contributions

Sudha247 commented 2 years ago

PSA: For those who've already worked on a good first issue, feel free to also look at issues with the tag help wanted.

ocaml-bench / sandmark