|
| 1 | +# Getting Started & Next Steps |
| 2 | + |
| 3 | +I want to just make sure everyone is on the same page by just outlining what to do next (as some people have been asking me via DM): |
| 4 | + |
| 5 | +## Get on Discord |
| 6 | + |
| 7 | +- Please make sure you are part of the Discord community. Here is a direct link to sign up: https://discord.gg/sFHSVR5 |
| 8 | +- Once logged in, make sure you look for the channel #teamhack on the left hand side of the channels area (the main area is where people chat). |
| 9 | +- Click on `#teamhack` to get to the Team Hack channel and then say hello, to let us know you're in! Mission 1 complete! |
| 10 | + |
| 11 | +## Book Mark Github |
| 12 | + |
| 13 | +Next, after you're on Discord, be sure to also have the Github community saved (bookmarked) in your browser. |
| 14 | + |
| 15 | +Here's the link: https://github.com/team-hack. |
| 16 | + |
| 17 | +## Fork A Repo, Create A Feature & Submit a Pull Request |
| 18 | + |
| 19 | +From Github, go to the repo for __coding-guidelines__. Fork this repo to your own Github by clicking the Fork button at the top right hand corner of the page. |
| 20 | + |
| 21 | +You should see a cool animation showing the coding guidelines repo being copied to your own Github. |
| 22 | + |
| 23 | +Now clone this repo to your local computer by selecting the __green Code button__ towards middle of page and using the command: |
| 24 | + |
| 25 | +```sh |
| 26 | +git clone <repo url> |
| 27 | +``` |
| 28 | + |
| 29 | +Do this inside your command line tool of choice (e.g. Terminal for Mac/Linux, Command Prompt or Powershell for Windows). |
| 30 | + |
| 31 | +For convenience, you may want to set up a public key for yourself so you can push and pull commits without having to type in a password. It's also more secure! |
| 32 | + |
| 33 | +After cloning the repo, go to your command line, then create a new feature branch, e.g. type: |
| 34 | + |
| 35 | +```sh |
| 36 | +git checkout -b "<featurebranchname>" |
| 37 | +``` |
| 38 | + |
| 39 | +You can now open up the folder in your favorite editor, e.g. VScode or Atom, and then make some changes. We recommend making changes to the __README.md__ file as it's just text (not code) so should be easy to add or change a few sentences. |
| 40 | + |
| 41 | +When you are done, go back to your command line, then be sure to add your changes, stage and commit. Finally push your work back to your own Github. Here are the commands you'll need: |
| 42 | + |
| 43 | +```sh |
| 44 | +git add --all |
| 45 | +git commit -m "My first commit" |
| 46 | +git push origin <featurebranchname> |
| 47 | +``` |
| 48 | + |
| 49 | +If successful, your code should get pushed back up to your Github repo. |
| 50 | + |
| 51 | +At the top of your own Github repo, select your feature branch from the dropdown, then you should see a new Green button in a yellow alert banner that says __Compare & pull request__. Click that button (or click Pull Request). |
| 52 | + |
| 53 | +Next, under "Open a pull request", make sure that everything looks correct -- basically your repo should request to merge with the team-hack/coding-guidelines repo. |
| 54 | + |
| 55 | +Under your commit message, you can write a description to further talk about what you are trying to submit. Click the __green "Create pull request"__ when you are done. |
| 56 | + |
| 57 | +Our team will review your pull request. If everything looks good we'll merge it with the "main" branch. If not, we will leave it open with comments for you to fix. |
| 58 | + |
| 59 | +If your pull request is merged in you can now delete your feature branch and start a new feature. This is recommended as each feature branch should be associated to its own scope of work for history review. |
| 60 | + |
| 61 | +Create a reference to the upstream branch Team Hack repo in your project by going to terminal and running: |
| 62 | + |
| 63 | +```sh |
| 64 | +git remote add upstream https://github.com/team-hack/coding-guidelines.git |
| 65 | +``` |
| 66 | + |
| 67 | +Pull in changes from upstream with: |
| 68 | + |
| 69 | +```sh |
| 70 | +git fetch upstream |
| 71 | +git merge upstream/main |
| 72 | +``` |
| 73 | +Your main branch should now be in sync with Team Hack's repo locally. |
| 74 | + |
| 75 | +You can now delete your feature branch with: |
| 76 | +```sh |
| 77 | +git branch -d <featurebranchname> |
| 78 | +``` |
| 79 | + |
| 80 | +Push everything so your own repo on Github is also in sync |
| 81 | + |
| 82 | +```sh |
| 83 | +git push |
| 84 | +``` |
| 85 | + |
| 86 | +__Any questions, please ask on Discord!!__ |
| 87 | + |
| 88 | + |
| 89 | +## Notes: |
| 90 | + |
| 91 | +We wanted to use the JIRA boards for doing the projects, but this becomes expensive if we have more than 10 people using the board. So we are opting to use the Github Project board instead, which works almost exactly identical to JIRA. We can also refer to JIRA anytime we want to learn anything there and bring over to our project boards; so in this way we help anyone who needs help being ready to work in a JIRA environment. |
| 92 | + |
| 93 | +Our first big project will be the components library that Ben talked about at our meeting. We will have another meeting to talk about that in more detail, but in the mean time feel free to use Discord as a place to ask questions and suggest more project ideas (especially if you want to do backend or ML or anything else). |
| 94 | + |
| 95 | +Thanks for your support and see you at the next meetup! |
0 commit comments