Skip to content

malligaraj/fastai-docment-sprint

 
 

Repository files navigation

Welcome to the Official fastai docment Sprint!

Getting Started

First you should quickly watch the introductory stream HERE. It will quickly catch you up to speed on how to contribute to the library, what the overall sprint will look like, as well as the recommended way to create your first PR!

Below are quick TL;DR's of what is stated in the video, meant as a quick reminder plus important links.

Who Can Join?

You!

More specifically, anyone and everyone is invited to come along and help with this endevor. No matter how much experience you have with coding or the library, with the exploratory aspect of this sprint and it being documentation focused, much of the library's insides will be new to folks and prone to discovery so absolutely come in and try it out!

Communication

Most of the repository of this sprint will live inside of the fastai discord. Inside, you can ping any of the senior members acting as guides throughout this sprint with any troubles, discuss the right way to approach a strange class, or just come say hi!

I (Zach Mueller) will also be commiting to streaming for 2-3 hours for at least 4-5 days a week in the evenings (around 6pm EST) inside the Discord, with a few streams in the early morning for folks in other timezones. To keep an ear out for when I stream either keep an eye on the discord, or follow me on twitter.

How do I "docment"? What is that?

A sprint-specific style guide is available here detailing this process, and the overall fastai-specific style-guide is available here.

How do I begin?

From the sprint-repo hit the "Fork" button on the top right corner, and begin editing your branch.

Be sure to check the active issues to see what sections of the library still need to be done to pick what you would like to docment

Once you are ready, open a "Pull Request" in the repo pointing to your fork, and write a clean Pull Request from the template describing what you docmented!

For a full video guide of this in-depth, please follow this link (LINK WILL BE LIVE POST STREAM)

Packages

No packages published

Languages

  • Jupyter Notebook 98.9%
  • Python 1.0%
  • CSS 0.1%
  • HTML 0.0%
  • JavaScript 0.0%
  • Makefile 0.0%