Skip to content

Instantly share code, notes, and snippets.

@felipe-ssilva
Last active October 15, 2019 22:23
Show Gist options
  • Save felipe-ssilva/a3e3dad454549400471cd202f02972ac to your computer and use it in GitHub Desktop.
Save felipe-ssilva/a3e3dad454549400471cd202f02972ac to your computer and use it in GitHub Desktop.
Good practices

Branchs name

  • Always in english
  • Task type
    • Feature: for new implementations
    • Hotfix: for fast fixes or something not considered before
    • Bug: for bugs
  • Name pattern
    • [task_type]/[task_id]-[task_target]
    • Example: task SCBOT-123 to implement a new menu
      • feature/scbot123-new-menu

Commits

  • Always in english
  • Task number*, an action (create, add, update, edit, fix, remove), what was done
    • Example: 'SCBOT-123 Update: desktop menu'
  • For partial commits, put the number of commit at the end
    • Example: 'SCBOT-123 Update: desktop menu #1'
  • to integrate with Jira

Code

  • Everything always in english
    • classes, ids, files names, functions, variables, comments
  • Comments
  • Semantic tags
  • Tags always with class or id
  • CSS selectors by class or id, not by HTML element
  • CSS in multiple lines (to easier understanding)
  • CSS properties in alphabetic order

Deploy

  • Always and only at the end of the sprint, except for urgency
    • get the package of implemented tasks and deploy it
  • Never on fridays, except for urgency

After arrive, git pull Before leave, git push

😉

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