pandas documentation sprint - Berlin 2020

When/Where is the sprint taking place?

• Sprint day: 21st of March, 2020
• Sprint time: 9am until 6pm
• Sprint location: Comtravo Gmbh in Berlin, Germany (get the directions here)

What are the goals of this sprint?

Our aims are to:

1. Improve the documentation of the pandas python library.
2. Increase the number of pandas contributors that belong to underrepresented groups in technology.

Who can attend?

Everyone can attend, but only 20 spots will be offered and we will give priority to participants belonging to underrepresented groups in technology.

We are commited to provide a harassment-free experience for all, and we will adhere to NumFOCUS code of conduct. Please take time to read it before attending the sprint.

How to register?

The registration for this sprint is now closed.

---

If invited to attend the sprint...

What should I bring the day of the sprint?

Bring your computer and don't forget your charger.

What should I do before the sprint?

If you come across any trouble following these steps, feel free to contact Martina Vilas.

1. Install Python

Make sure you already have Python > 3 installed. If you don't, follow the steps outlined here.

2. Setup a GitHub account

• Open an account on GitHub.
• Install Git on you local machine if you haven't.
• Review some Git resources if you're not yet familiar with it.
  • Some recommendations for learning git:
    • Read git - the simple guide for a simple explanation of git's most famous commands.
    • The book Pro Git gives an in depth explanation of git.
    • You can also learn git branching by playing games.
    • Here is a link to more resources.
  • To get familiar with GitHub, read their guides.

3. Install a text editor

We recommend Visual Studio Code

4. Join gitter

Gitter is a chat room system for developers and users of GitHub repositories. Join the Gitter community for pandas documentation sprints here. You can use your GitHub username to sign in.

5. Install the pandas development environment

To contribute to pandas you need to install a development environment. This should be done before attending the sprint.

To set up the development environment, follow these instructions. We recommend setting up a conda environment.

6. Fork the pandas-dev repository, and clone your fork into your local machine

• Read the github guide for forking and cloning if you don't know how to do this.
• Make sure your remote origin is pointing to your pandas-dev fork, and your remote upstream is pointing to the pandas-dev repository.

7. Get familiar with the pandas contributing guideline

• You can read the pandas contributing guideline here.
• Skip to this part to read about contributing to the documentation.
• You can read more about this topic browsing through these links.

8. Get familiar with pandas docstrings

• Read about pandas doctrings.
• Read examples of docstring errrors.

How are we going to work during the sprint?

The day of the sprint we will upload docstring errors in pandas as issues in this repository. Each person will choose one (or more if time) to work on, and will submit the fix to the pandas repository. We will provide help and mentoring. You can choose to work in pairs as well.

Thanks to our generous sponsors from Comtravo, we will offer lunch (vegetarian option only) to participants the day of the sprint.

Credits

This repository is adapted & modified from https://github.com/WiMLDS/berlin-2020-scikit-sprint. Thank you!