Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sprint info #47

Merged
merged 29 commits into from
Jun 17, 2022
Merged
Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
8f02d37
:pencil: adding label
symeneses Jun 14, 2022
972d025
:truck: move cheatsheet
symeneses Jun 14, 2022
d160397
:art: rename label
symeneses Jun 14, 2022
f26145a
:sparkles: add sprint general info
symeneses Jun 14, 2022
6be42bd
:bug: typo
symeneses Jun 14, 2022
c584952
:sparkles: add faq and resources
symeneses Jun 14, 2022
cb2c877
:pencil2: fix typos
symeneses Jun 14, 2022
9651f25
:pencil2: remove level 2
symeneses Jun 14, 2022
516e6e5
:lipstick: move sprint info to index
symeneses Jun 14, 2022
4e0fa28
:bookmark: add label
symeneses Jun 14, 2022
1741a26
:lipstick: adding refs
symeneses Jun 14, 2022
fde92e1
: pencil: update sprint description
symeneses Jun 15, 2022
27c3e71
:pencil: change header
symeneses Jun 15, 2022
c49fbb6
:pencil: use ref
symeneses Jun 15, 2022
5de1e52
:lipstick: change levels
symeneses Jun 15, 2022
527283d
:fire: remove old sprint guide
symeneses Jun 15, 2022
d311025
:sparkles: add prep work
symeneses Jun 15, 2022
a61d346
:pencil: add live share video
symeneses Jun 15, 2022
934594c
:pencil: remove specific content
symeneses Jun 15, 2022
c8d5153
:lipstick: embed video
symeneses Jun 16, 2022
433f82d
:lipstick: hide faq
symeneses Jun 17, 2022
c64f147
:art: splitting docstring_tutorial
symeneses Jun 17, 2022
cb6cad0
:pencil: add 1 faq
symeneses Jun 17, 2022
78b68f6
:pencil: add faq
symeneses Jun 17, 2022
6ece92d
:art: move create feature branch to pr_tutorial
symeneses Jun 17, 2022
e4f5fc9
update tutorials
OriolAbril Jun 17, 2022
94299cb
add image
OriolAbril Jun 17, 2022
cfc3499
Merge branch 'sprint-info' of github.com:symeneses/pymc-data-umbrella…
OriolAbril Jun 17, 2022
c877750
fix references
OriolAbril Jun 17, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions 2022-07_sprint/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
(current_sprint)=
# July 2022 sprint
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@reshamas should we update all mentions of "sprint" to "open source working sessions"?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, please!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How to rename the headers Sprint info and Sprint events in a short form?

  • Something like: OS session info, or Session info and OS events or simply Events

Then, Sprint guide and Sprint preparation would be Session guide and Session preparation?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@reshamas should I change this as suggested here?


:::{toctree}
Expand Down
1 change: 1 addition & 0 deletions about/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
(about_pymc)=
# About PyMC

% TODO: add nice text
Expand Down
2 changes: 2 additions & 0 deletions sprint/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Frequently Asked Questions
symeneses marked this conversation as resolved.
Show resolved Hide resolved

70 changes: 67 additions & 3 deletions sprint/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,74 @@
# Sprint info

% TODO: arreglar toctree y texto

:::{toctree}
:maxdept: 1
:maxdepth: 1
:hidden:

self
symeneses marked this conversation as resolved.
Show resolved Hide resolved
sprint-guide
sprint-cheatsheet
prep-work
faq
resources
:::

::::{div} sd-fs-5
:::{tip}
* **Wondering if the sprint is for you?** We have got just {ref}`the page <decision_tree>`
* **Ready to contribute?** Go to {ref}`docstring_tutorial` page
:::
::::

(sprint)=
## Open Source Working Sessions

Data Umbrella is organizing a series of open source working sessions to contribute to the PyMC project. For more information, see {ref}`Resources <resources>` section.

## Goals

In this sprint we’re focusing on bringing in new contributors, we sincerely hope this will be a welcoming, inclusive experience for you into the world of open source software. We hope to help you to the best of our abilities and learn from you as well!
The sprint will consist of small resolvable issues and contributing to the PyMC documentation, so if you aren’t experienced in software development no worries at all, you can contribute to documentation with knowledge of markdown or statistics.
Here’s the fun part, we’ll be giving away stickers, mugs and the Bayesian Computation book by PyMC Developers Ravin, Junpeng and Osvaldo!!! Find the schedule and all other details {ref}`here <current_sprint>`.
symeneses marked this conversation as resolved.
Show resolved Hide resolved
symeneses marked this conversation as resolved.
Show resolved Hide resolved

## Requirements

- Get your laptop, and some stable internet connection!
- Working knowledge of terminal and git
- Setup a python virtual environment beforehand!
- Other than these two you can make different kinds of contributions with different skill sets, for example:
- You can contribute to documentation with knowledge of markdown and maybe some basic statistics
- You can contribute to CI/CD issues or Python issues with basic knowledge of programming
- You can contribute to core codebase with knowledge of Python + Bayesian Statistics
- Note: {ref}`Check the sprint cheat sheet <decision_tree>` to know a suitable area of contribution and some resources to prepare you for it

## Target Audience
The following table answers the question **"This sprint is for someone who is/has ..."**

:::{list-table}
:header-rows: 1
:stub-columns: 1
:widths: 7 1 1

* -
- Yes
- No
* - New to Open source
- {fas}`check;sd-text-success`
- {fas}`check;sd-text-success`
* - Statistical background
- {fas}`check;sd-text-success`
- {fas}`check;sd-text-success`
* - Currently working in data science/software
- {fas}`check;sd-text-success`
- {fas}`check;sd-text-success`
* - Knows/uses PyMC
- {fas}`check;sd-text-success`
- {fas}`check;sd-text-success`
* - Member of the PyMC team
- {fas}`times;sd-text-danger`
- {fas}`check;sd-text-success`
:::

Read the {ref}`decision_tree` for more detailed answers and to see
what types of contributions can you make depending on your interests and
background.
109 changes: 0 additions & 109 deletions sprint/old-sprint-guide.md

This file was deleted.

35 changes: 35 additions & 0 deletions sprint/prep-work.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Sprint preparation

## Checklist

:::{list-table}
:header-rows: 1
:stub-columns: 1
:widths: 1 4 1 2

* - #
- Task
- Status
- Notes
* - 1
- Have a GitHub account?
- {fas}`check;sd-text-success`
-

:::


## Sprint day

%TODO: Improve text%

:::{tip}
To communicate during the sprint, we will be using Discord. The [Using the Discord Server](https://youtu.be/w2A8SknM-68) introduction video contains a brief introduction to the Discord Data Umbrella server with some tips on how to navigate the application.
:::

### Pair programming

Live Share is an extension from Visual Studio Code that allows you to collaboratively edit and debug with others in real-time. It allows you to instantly share your current project, edit snippets of code at the same time or follow someone’s cursor while they program. To learn more about Live Share, visit [Live Share with Visual Studio Code](https://youtu.be/WHOiljOYGVw).

symeneses marked this conversation as resolved.
Show resolved Hide resolved

### Environment setup
symeneses marked this conversation as resolved.
Show resolved Hide resolved
14 changes: 14 additions & 0 deletions sprint/resources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
(resources)=
# Resources

- {ref}`PyMC - Data Umbrella series content and videos <about_pymc>` (all webinar materials have been uploaded to this website, videos are embedded too so you have everything just a click away)

- {ref}`Sprint Cheat Sheet <decision_tree>`

- [Reshama Shaikh: Example of Submitting a Pull Request to PyMC Documentation](https://www.youtube.com/watch?v=NbmdFJsnuuo)

- [Using Discord for sprint](https://youtu.be/w2A8SknM-68)

- [Live Share with Visual Studio Code](https://youtu.be/WHOiljOYGVw)

- [Git Notes](https://www.dataschool.io/how-to-contribute-on-github/)
File renamed without changes.
7 changes: 2 additions & 5 deletions sprint/sprint-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ These breakout rooms aren't rigid, you can choose which one you wish to be in, t

## Volunteer Guide

1. Breakout rooms will be created at the begining of the meeting, but do join 15 minutes before the sprint so you can get the hang of Zoom and these rooms to make things smoother.
1. Breakout rooms will be created at the beginning of the meeting, but do join 15 minutes before the sprint so you can get the hang of Zoom and these rooms to make things smoother.
2. Feel free to create new breakout rooms, if needed.
3. Be patient and kind to sprint participants, if you feel unable to help someone with a doubt or issue, redirect it to another volunteer or PyMC team member if someone is available. If that does not work, consider suggesting a new issue to the participant.
4. Encourage people to introduce themselves and ask questions.
5. Do flag any(really ANY) inappropriate behaviour. Warn the participant or remove them from the Zoom meeting in these cases:
5. Do flag any (really ANY) inappropriate behaviour. Warn the participant or remove them from the Zoom meeting in these cases:

- They make a discriminatory remark
- They are being persistently rude
Expand All @@ -45,6 +45,3 @@ These breakout rooms aren't rigid, you can choose which one you wish to be in, t
Cheers, have fun folks!

[Sprint Organizers](https://github.com/pymc-devs/pymc/projects/4)