SHM Project

Table of contents:
     - Go to the CodersSchool Readme
     - Project overview
     - Workflow cheat sheet
             1. Choose a task for yourself
             2. Create branch
             3. Work
             4. Post-Work
             - Creating new tasks

Overview

  - Project Contributors:
          - Kacu (Ptysiek)
 
  - Branch master is intended for CodersSchool oryginal content
    with an exception for documentation and markdown files.
 
  - Branch shm-master is the target branch for everything related to shm code.
    Your branches should start from it and be merged into it.

Workflow

1. Choose a task for yourself

  1. Go to the Projects tab and select the one you are working on.

  2. Select your task from the ToDo column. Drag and drop it into the InProgress column.
     Don't take more than one task.
     If you want to reserve a task drag it into PlannedForTomorrow column.
     Your task in the PlannedForTomorrow column will be your next task to drag into InProgress.
     Also don't take more than one.

  3. You can learn more about selected task by clicking on its title.
     From this side-panel Assign yourself to the task.

2. Create branch

  1. Make sure that you are on shm-master branch.
  2. Make sure that the shm-master branch is up to date.
  3. Create new branch.
         - First number is always the index of the task / issue.
         - Next copy-paste the title of that task.
         - Always use lower case characters for branches.
         - KebabCase. Turn all spaces into: -
    
         Examples:
         - Task title: CS-Task1 Task index: #1 Branch name: 1-cs-task1
         - Task title: Describe project workflow Task index: #3 Branch name: 3-describe-project-workflow
  4. Set branch upstream to itself.

3. Work

  Get your task done.
  Each commit start with index of your task, it's the same index as your current branch.
  Use lower case characters.
  Don't use KebabCase for commits, use spaces instead.
  Describe your commit shortly in past tense.
  For example, on branch 1-cs-task1 the commit could look like 1 created new Store class.
  And for 3-describe-project-workflow branch
  the possible commit is 3 moved screanshots into documentation catalog.

4. Post-Work

  It's time to create Pull Request. Find your way into branches list and push New Pull Request from your branch.

  1. Change target repository.
  2. Change target branch into shm-master.
  3. Press Create pull request.

  4. From the right panel link issue and assign project.
  5. Optionally fill up the remaining { Reviewers, Assignees, Labels }
  6. Go to the Projects tab and move your task into the InReview column.

Creating new tasks

  Don't create tasks from Projects tab. Go to the Issues tab instead.
  Write English only.
  Add description, it's a good thing to copy-paste link
  to the task from coders school or to the thread from code review.
  Create new issue, assign project and labels.
  Task unique index will be generated automatically so you don't need to think about it.