Skip to content

Instantly share code, notes, and snippets.

@amitpatelx
Created October 2, 2020 08:19
Show Gist options
  • Save amitpatelx/0285e46bbdf4c7cdc3a71ce2c11a2539 to your computer and use it in GitHub Desktop.
Save amitpatelx/0285e46bbdf4c7cdc3a71ce2c11a2539 to your computer and use it in GitHub Desktop.
Spiders > Development and Deployment Processes (WIP)

This page outlines about practices we are following related to development and deployment

Branches

  1. Create branch from master branch unless explicitely mentioned.
  2. Every spider should have own branch.
  3. Pull latest changes from the master/parent branch before creating a branch from it.
  4. Branch name should be self-explanatory, probably same as name of the spider.
  5. Avoid creating nested branches from working branches. Do proper planning before start coding to avoid nested branching.

Commits

  1. Implement spiders in small commits.
  2. Each commit should have a very explanatory message which resembles the change you are committing.
  3. Learn commit message good practices

Pull Request(PR)

  1. Before creating PR do self code review(CR). If you find any issues/improvements, postpone creating PR and fix the issues first.
  2. Inform team members to do CR by mentioning them in PR comment if required.
  3. Squash merge all commits to create a single commit while merging to master. Follow commit message conventions.
  4. Delete the working branch once it is merged to master.

Pre-Deployment

TBD

Post Deployment

TBD

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment