General onboarding doc #16
Conversation
|
Maybe we should reduce this to only include engineering-related topics. |
| @@ -0,0 +1,76 @@ | |||
|
|
|||
| One of the challenges is learning how, why and when to use these tools. | ||
| This is a brief overview to help that process along. | ||
|
|
||
| ## COMMUNICATION |
There was a problem hiding this comment.
Agreed with Ludwig on this being engineering specific. I think we can delete this section
| For QA, onboarding is more about familiarizing yourself on a broad spectrum with what the project is/should be. | ||
| This usually means digging around the Jira board, reading documentation from Google Docs and talking to devs or other QAs who’ve worked on the project if not new. | ||
|
|
||
| ## Other |
There was a problem hiding this comment.
Ditto here about deleting this section.
| If someone’s nearby and obviously available and you want to talk, then go for it. | ||
|
|
||
| ## DEVELOPMENT | ||
| ### GitHub |
There was a problem hiding this comment.
We could probably mention Git as part of this and link off to helpful guides like https://git-scm.com/book/en/v2 and https://ohshitgit.com/ and https://devhints.io/git-tricks
There was a problem hiding this comment.
This is another good page for Github: https://guides.github.com/
| It’s essentially a modern day wall of post-it notes of to-dos for a project. | ||
| ### Google Docs | ||
| This is where non-code project files live, e.g. test plans, spreadsheets, expense reports, discovery notes, design images, etc. | ||
| ### WORKFLOW |
There was a problem hiding this comment.
| ### WORKFLOW | |
| ### Workflow |
There was a problem hiding this comment.
Another protip that has helped me a ton is at the end of the day, leaving a # TODO: in the code reminding you of where you left off
| ### Development Environment | ||
| As far as your development environment, (language and framework versions, browsers, etc.) in addition to reading the other docs in this repo, this is worth conversations with other SB devs. | ||
| There is much variation and the projects being worked on will largely dictate what you’ll be using. | ||
| Personal preference comes into play too, so if you know what text editor you prefer for instance, there’s not one standard for most aspects of an environment. |
There was a problem hiding this comment.
It might be worth mentioning that a majority of us use VSCode, some use vim and atom.
| At the start of every work day, a suggestion as a first task is to open and view Google Calendar, Slack and your SB email. | ||
| Maintaining a connection to these throughout the day is wise. | ||
| ### Development Environment | ||
| As far as your development environment, (language and framework versions, browsers, etc.) in addition to reading the other docs in this repo, this is worth conversations with other SB devs. |
There was a problem hiding this comment.
It would be good to link out to those other docs when we have them. Particularly, the ones around asdf and such.
No description provided.