-
Notifications
You must be signed in to change notification settings - Fork 3
Contributor Onboarding (First chapter or two) #12
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
Open
makew0rld
wants to merge
14
commits into
master
Choose a base branch
from
onboarding
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
5c69ba3
Initial work
makew0rld 6852219
Linting fixes
makew0rld 13c8ff5
Image link fix
makew0rld 9b42e0d
Update src/onboarding/github.md
Shrinks99 f9c7eef
Update src/onboarding/github.md
makew0rld ff6021d
Update src/onboarding/github.md
makew0rld 10b54d2
Spelling and removing some yous
makew0rld d2fa92f
Apply suggestions from code review
makew0rld ec71976
Merge branch 'master' into onboarding
makew0rld 6d2c45a
Fix tone
makew0rld a2fa812
Mention issue template
makew0rld 90671eb
Merge branch 'master' into onboarding
makew0rld d32916c
Fix lint errors
makew0rld 75f33cb
Merge branch 'master' into onboarding
makew0rld 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 |
|---|---|---|
|
|
@@ -34,3 +34,6 @@ colocated | |
| https | ||
| http | ||
| [cC]yber | ||
| [oO]nboarding | ||
| repo | ||
| Kanban | ||
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
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,3 @@ | ||
| # Git | ||
|
|
||
| In progress. |
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,61 @@ | ||
| # GitHub Tickets | ||
|
|
||
| GitHub is a service that provides code hosting and versioning. We also use it for its collaborative features, such as issue/bug tracking and project boards. This documents explains how to use GitHub to keep track of tasks. | ||
|
|
||
| ## Repositories | ||
|
|
||
| Here is the homepage for the [toronto-community-network](https://github.com/tomeshnet/toronto-community-network) repository. | ||
|
|
||
|  | ||
|
|
||
| A repository (or "repo") is like a project on GitHub, with a collection of files and a name. You can see the name of this one, `toronto-community-network` and that it was created by the [tomeshnet](https://github.com/tomeshnet) organization. | ||
makew0rld marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| You can see an overview of the files and folders in the middle of screen, and below that you can see what's called the README, which is a file that explains what the repository is for. If you click on `README.md` you'll see it has the same contents as the text on the homepage. | ||
makew0rld marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
makew0rld marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Issues | ||
|
|
||
| If you click on `Issues` tab you'll see this: | ||
makew0rld marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
|  | ||
|
|
||
| This tab provides a list of all the issues that have been created for this repository. Issues are similar to the idea of "tickets" or bug reports. It allows us to keep track of tasks or potential plans. All issues have numbers, referenced with a hashtag, such as #32, which can be found [here](https://github.com/tomeshnet/toronto-community-network/issues/32). | ||
makew0rld marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| If you look at that issue (or any others), you will see an initial comment explaining what the issue is for, and a discussion going on below about the issue, with reactions, editing, links, etc. The initial comment will change and get edited by others over time as new information is known. | ||
|
|
||
|  | ||
|
|
||
| Issues also have assignees, which you can see in the sidebar. These are the users responsible for completing this task. You can assign yourself or other people. | ||
|
|
||
| Issues can either be open or closed, which denotes their completion. Issues are closed once they're no longer relevant, or when the original task or bug has been fixed. | ||
makew0rld marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Labels | ||
|
|
||
| You'll notice on the sidebar that issues can have labels, projects, and milestones, which we'll get into later. If you click on a label, you can view all the issues with that label. For example, here are all the communications issues: | ||
|
|
||
|  | ||
|
|
||
| Using the sidebar, you can filter by other labels if needed. | ||
makew0rld marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
|  | ||
|
|
||
|
|
||
| ## Projects | ||
|
|
||
| [#32](https://github.com/tomeshnet/toronto-community-network/issues/32) is also linked to a project, as can be seen in the sidebar. | ||
|
|
||
|  | ||
|
|
||
| If you click that text or click the Projects tab at the top, you'll be able to see the project. Repositories can have multiple projects, but in this repository there is just one. Here is what it looks like: | ||
makew0rld marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
|  | ||
|
|
||
| A GitHub Project is a type of [Kanban](https://en.wikipedia.org/wiki/Kanban_%28development%29) board for organizing issues. | ||
| Each of the cards are issues, which can be in different columns. We use a standard setup with To Do, Doing (aka "In Progress"), and Completed columns. | ||
| We also have a Backlog column on the far left for low-priority tasks. Issues can be moved from column to column as needed, to indicate their status. Issues will automatically be moved to Completed when they're closed. | ||
makew0rld marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Issues in the project can also be filtered by label by clicking on a label, for example you can see all the communications issues in the project [here](https://github.com/tomeshnet/toronto-community-network/projects/1?card_filter_query=label%3Acommunications). | ||
|
|
||
|
|
||
| ## Creating your first issue | ||
|
|
||
| TODO | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 @@ | ||
| # Contributor Onboarding |
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,3 @@ | ||
| # Markdown | ||
|
|
||
| In progress. |
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,3 @@ | ||
| # Pull Requests | ||
|
|
||
| In progress. |
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.