ga-wdi-remote / HOW-TO-USE-THIS-ORG

READ FIRST: How to contribute, repo naming conventions, and content/solution styleguide
0 stars 0 forks source link
contributing how-to naming-conventions

How to use this organization and contribute

What it is

This Organization holds repositories of lessons and daily class work, labs, homework, and installation lessons.

Contributing

Before creating a new repository search through organization to make sure your content is unique. You can search by repo topic names like lesson and homework or by topics like javascript, express, mongoose, ruby, rails,

If it is not unique

Clone the repository that contains an version of your content and make a new branch to push your content to.

see naming conventions below

If it is unique

Create a new repository with a master and a solution branch.

Label your repo with Topics by clicking the Settings tab in the organization, and clicking Repository topics.

Find your repo in the list and add the relevant tags to make the repo easily searchable from the org home page.

Be sure to definitely label your repo as either lesson, homework, lab etc and the technologies required.

Naming Conventions

Repositories

Name of the repo should start with language/tech abbreviation followed by the type of content and the name of the assignment.

examples:

js-hw-function-reps
ruby-lab-banana-stand

Once the repo is created add a description to the repository describing the content if there are things specific to the content that should be known early.

For Example:

That the lab in a repo is a multi-day assignment or dependent on the content in some other repo etc.

Branches

Every repo should have the starter code, lesson, README, instructions, examples, on the master branch.

The solution code in a solutions branch.

Iterating on existing content

If changes are updates be sure to update the master branch as well as the solution branch.

Adding a new version of existing content

Your branch name should include your name and whether it's the master or the solution.

master
<your name>-solution

Making Changes

Create an issue on the repo in question and list the problem, proposed fix, or addition and the associated branch, file, line number, etc.

The content owner can either make that change or suggest that it goes into a new version of the lesson made by you!