-
-
Notifications
You must be signed in to change notification settings - Fork 804
Adding initial content for Sprint Guide #609
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
ca3a229
Initial Sprint Guide content.
kattni b9214a5
Add screenshot and explanation.
kattni fc27e98
Apply suggestions from 9 April code review
kattni dfa9ea0
Updates per review, typo fixes.
kattni ed74930
Add shortlinks for the sprint guide.
freakboy3742 05de06b
Updates to the sprint contribution guide.
freakboy3742 fbf4368
Always point to the latest contribution guides.
freakboy3742 3c77f6d
Tweak the linking text for sprints.
freakboy3742 c2d8b1f
Corrections and clarifications from review
freakboy3742 e4f1472
Tweak the text around asking questions.
freakboy3742 ceb2369
Final tweaks.
freakboy3742 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 hidden or 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,75 @@ | ||
_model: page | ||
--- | ||
title: Sprint Guide | ||
--- | ||
body: | ||
|
||
Welcome to the BeeWare Sprints! | ||
=============================== | ||
|
||
Welcome! We're so excited you've decided to join us! If you haven't already introduced yourself to one of the Bee Team, please do so. Once you've done that, head back here to get started. | ||
|
||
The Initial Questions | ||
---------------------------- | ||
Answering these questions is the first step towards joining the BeeWare sprints. Let's get started! | ||
|
||
1. Do you know how BeeWare works? TODO: Reword? | ||
kattni marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- No: Start with the `BeeWare Tutorial <https://docs.beeware.org/en/latest/>`_. | ||
- Yes: Continue to question 2. | ||
|
||
2. What do you know and what kit do you have with you? | ||
kattni marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- TODO: Clarify and expand on "what do you know" | ||
- Is your laptop Windows, MacOS, Linux, or other? Is your mobile device iOS, Android, or other? | ||
|
||
3. Why did you join us and what are you interested in? | ||
- "You sounded like a friendly project" is a perfectly fine answer. However, if there's more to why you joined us today, let us know. | ||
- Are you interested in mobile or desktop development? Packaging? Websites? Console apps? If you didn't come prepared with a specific interest, what seems most interesting? | ||
|
||
4. What is your skill set? | ||
kattni marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- Are you brand new? Been programming for years? | ||
- Are you familiar with Python? More comfortable with documentation? | ||
- Have you ever worked with a GUI (graphical user interface)? | ||
- Have you ever submitted a PR (pull request) to a project? Do you know what CI (continuous integration) is? | ||
|
||
Write down your answers to these questions, and find a Bee Team member to help you figure out where to start with your BeeWare sprint! | ||
kattni marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Find Your Issue | ||
---------------- | ||
|
||
Now that you know which tool(s) to start with, take a look at the applicable GitHub Issues list, and see whether anything looks interesting. | ||
kattni marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
If you're new to contributing, you can filter the list by the "good first issue" label. This will display only issues we think are a good fit for new folks. | ||
kattni marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
To filter a GitHub issue list by the "good first issue" label, follow these steps: | ||
|
||
1. Click on the "Labels" button above the list of issues to activate the drop-down menu. | ||
2. Type the word "good" into the search box at the top of the drop-down menu. | ||
3. Click on "good first issue" in the filtered list. | ||
|
||
.. figure:: ./github-good-first-issue-filter.png | ||
:width: 100% | ||
:alt: The GitHub issue label filter drop-down menu activated with a search for the word "good" to filter down to "good first issue". | ||
|
||
*Filtering GitHub issues by the "good first issue" label.* | ||
|
||
If you can't find anything you'd like to do, please ask a Bee Team member to help you find something that works for you. | ||
kattni marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Common Questions | ||
----------------- | ||
|
||
These are commonly asked questions. If you have a question, check here first. If you don't see your question, ask a member of the Bee Team. | ||
|
||
- Can I use the Android API? | ||
- TODO: Answer this. | ||
- TODO: Fill in with the common questions. | ||
- TODO: Fill in answers. | ||
--- | ||
gutter: | ||
|
||
The Bee Team is always available to answer questions. If you're in doubt... Ask! | ||
|
||
**This guide is new! PyCon US 2025 is the first time we've used it. We want your feedback! What worked for you? What didn't? What can we do better? Please let us know. And remember: contributing to the Sprint Guide is contributing to BeeWare!** | ||
kattni marked this conversation as resolved.
Show resolved
Hide resolved
|
||
--- | ||
summary: A guide for the BeeWare Sprints | ||
--- | ||
sort_key: |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
Uh oh!
There was an error while loading. Please reload this page.