/GWGpractice

GWG practice repo to get experience with GIthub

README

The purpose of this practice repo is to get experience using & collaborating with git and GitHub. If you don't have one already, please create a GitHub account as it is required to contribute to the project.

This document serves as a README that may be used later as an Initial Commit in a subsequent GwG Project Repo.

Instructions

@lestec

Hi everyone from GWG! Your first mission is to read through this README.md file in its entirety as it lays out important group project details. At the end, you will be given a chance to select a team to contribute with and will be providing the following:

  • name
  • discussion forum username
  • slack username

Making a Pull Request: Why?

One of the key points of the feature branch workflow is that the developer who wrote the code does not merge the code with master until there has been a peer review. Leveraging Github's pull request features, once you have completed the feature branch and pushed it to the repo, there will be an option to review the diff and create a pull request.

More information below

With all of that being said, lets make some changes below. Have fun and good luck!


Table of Contents

Website Objective

Learning Git and GitHub

How I Pulled This Repo Using GitHub

Current Group Tasks and Deadlines

Project Goals

Project Team Sign Up

Teams

@chrisneal

Website Objective

The majority of us have voted to do a site dealing with links and resources. Now we just need to focus more on that objective.

How about a site compiling links, tutorials, and articles shared in the Udacity Discussion Forums? This would ultimately be a site where the following class could visit and learn the best resources on how to tackle the challenge lessons from the course - anything that has helped us and others (git/Github links, JavaScript articles, motivational tips, etc.) towards moving on to the Front End Nanodegree course.

We can think about and expand on this concept a little more, 1-2 weeks should be plenty of time to gather ideas and identify the main concept of the website.

[back to top]

Learning Git and Github

If you haven't already, please begin learning the fundamentals of git and collaborating on GitHub. Most of the fundamental learning will involve using git on your local machine and we will be using GitHub's collaborative features to build together.

This is necessary, especially if you plan to contribute code to the project.

Git and GitHub Learning Resources

Here's some links that were passed around in the forums that I believe are some of the best and I added some that really got me on track with making pull requests and stuff (SPOILER: it's easy!).

How I Pulled This Repo Using GitHub

@lestec initialized this repo and wrote the introduction to this README.md for us all to work on. Thanks again! This is what I did to contribute to it, step-by-step:

  1. Visit the main repo and fork the repository I went to her GwGpractice Github page, (she also posted the link in the forum). The fork should link back to your page and place you inside that repository.

Note: You can actually make minor revisions from this page and create a pull request all from the interface. It's good for practice with minor code fixes, etc. However, I suggest we all do what I did in the next step...

  1. Clone that fork from your page to your local machine. Here's some help

***Tricky part: The master branch was there, but I didn't see the dev branch we'll be pushing our changes to to make pull requests. To get that latest branch I first created a branch off the master named [my name]-dev.

 git checkout -b chrisneal-dev

That's the syntax we'll use for making our branches/changes for now: [your name]-dev

I merged the latest changes (from the dev branch online) by using

git merge origin/dev

The experience may be very different for you, if any issues come up we'll pull you through.

  1. Make your changes and push them From there, I was able to make changes to what she had and pushed my changes (this part of the document) up to my GitHub fork. At this point is where I began the pull request process. If you have any questions about any or all of this from here, ask one of us and we can help or refer to one of the Git learning resources.

    [back to top]

Current Group Tasks and Deadlines

  • We have 1 week (by March 4th or 5th) to choose a team to contribute with. How would you like to contribute? More details below.

  • We have 1-2 weeks (by March 12th?) to:

    • Learn and understand the fundamentals of git and collaborating on GitHub
    • Revise and understand the website/application's main objective & purpose
    • Create somewhat of an initial layout/design of the main page

Project Goals

  • Learn git/GitHub & web development in a "remote group environment"
  • Create a simple project; 1-2 pages w/ room to expand
  • Practice what we've learned so far in the course
  • Be challenged! Not overwhelmed
  • Work in small teams, hoping everyone will have a meaningful role

Project Team Sign Up

Let's keep this process simple!

The only change you will be making for now is adding your name to whichever team you'd like to contribute with using the format below.

This syntax creates a table in Markdown, all you have to do is edit/insert your information like so:

Name         | Disc Forum @ | Slack @ | Link (optional)
-----        | -----        | -----   | -----
(your name)  | (your @)     | your @  | optional link

You'll get it when you see how others have done it. If not, just ask someone. This list will determine who the contributors are for this project. Adding your name to a table is as easy as separating your info with the pipe character like this:

name | disc forum name | slack name | (optional link)

You can be on more than one team, just make sure there are enough duties for everyone to contribute meaningfully.

[back to top]


Teams

Wireframe and layout design

Contributors in this group will create a mockup/wireframe/sketch of what the site would look like and would most likely be initiating CSS styling.

Name Disc Forum @ Slack @ Link (optional)
(your name) (your @) your @ optional link

index.html

Contributors in this group will work with the wireframe and layout design team to create the initial index.html file.

Name Disc Forum @ Slack @ Link (optional)
(your name) (your @) your @ optional link

HTML refactoring and optimization

Contributors in this group will refactor and optimize the structure and semantics of the index.html file (checking syntax errors, etc.)

Name Disc Forum @ Slack @ Link (optional)
(your name) (your @) your @ optional link

CSS refactoring and optimization

Contributors in this group will refactor and optimize the structure and semantics of the stylesheet file (checking syntax errors, etc.)

Name Disc Forum @ Slack @ Link (optional)
Chris Neal chrisneal Chris N github/chrisvneal

JavaScript refactoring and optimization

Contributors in this group will refactor and optimize the structure and semantics of the .js file, ensuring best practices (checking syntax errors, etc.) Contributors may also choose to initiate interactivity scripting when necessary.

Name Disc Forum @ Slack @ Link (optional)
(your name) (your @) your @ optional link

Asset gathering

Contributors in this group will gather resources for images, icons, and media pertaining to the main concept while working closely with the wireframe layout and index.html teams for guidance.

Name Disc Forum @ Slack @ Link (optional)
(your name) (your @) your @ optional link

Copy and grammar editing

Contributors in this group will help spot grammatical and spelling errors within the site's body & content.

Name Disc Forum @ Slack @ Link (optional)
(your name) (your @) your @ optional link

Git Assistance

Contributors in this group will

  • help manage the main project repo GWGpractice
  • help others with git and pull requests on Github and
  • help with code review of any code before it gets merged into the main project branch, master.
Name Disc Forum @ Slack @ Link (optional)
Leslie Tecumseh lestec lestec github/lestec
Chris Neal chrisneal Chris N github/chrisvneal

[back to top]