-
-
Notifications
You must be signed in to change notification settings - Fork 38
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
Sprint info #47
Changes from 18 commits
Commits
Show all changes
29 commits
Select commit
Hold shift + click to select a range
8f02d37
:pencil: adding label
symeneses 972d025
:truck: move cheatsheet
symeneses d160397
:art: rename label
symeneses f26145a
:sparkles: add sprint general info
symeneses 6be42bd
:bug: typo
symeneses c584952
:sparkles: add faq and resources
symeneses cb2c877
:pencil2: fix typos
symeneses 9651f25
:pencil2: remove level 2
symeneses 516e6e5
:lipstick: move sprint info to index
symeneses 4e0fa28
:bookmark: add label
symeneses 1741a26
:lipstick: adding refs
symeneses fde92e1
: pencil: update sprint description
symeneses 27c3e71
:pencil: change header
symeneses c49fbb6
:pencil: use ref
symeneses 5de1e52
:lipstick: change levels
symeneses 527283d
:fire: remove old sprint guide
symeneses d311025
:sparkles: add prep work
symeneses a61d346
:pencil: add live share video
symeneses 934594c
:pencil: remove specific content
symeneses c8d5153
:lipstick: embed video
symeneses 433f82d
:lipstick: hide faq
symeneses c64f147
:art: splitting docstring_tutorial
symeneses cb6cad0
:pencil: add 1 faq
symeneses 78b68f6
:pencil: add faq
symeneses 6ece92d
:art: move create feature branch to pr_tutorial
symeneses e4f5fc9
update tutorials
OriolAbril 94299cb
add image
OriolAbril cfc3499
Merge branch 'sprint-info' of github.com:symeneses/pymc-data-umbrella…
OriolAbril c877750
fix references
OriolAbril File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
(current_sprint)= | ||
# July 2022 sprint | ||
|
||
:::{toctree} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
(about_pymc)= | ||
# About PyMC | ||
|
||
% TODO: add nice text | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, please!
There was a problem hiding this comment.
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
andSprint events
in a short form?OS session info
, orSession info
andOS events
or simplyEvents
Then,
Sprint guide
andSprint preparation
would beSession guide
andSession preparation
?There was a problem hiding this comment.
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?