search

jrf-systems / docsify-deploy

A handy documentation deployment tool for Docsify and GitHub
0 stars 0 forks source link

Work standards and guidelines #25

Open Maddix opened 4 years ago

Maddix commented 4 years ago

Why do we have this?

Everyone has patterns they follow when working and unless we talk about them, standardize, and agree on how to work together we will trip each other.

How to create branches

We're going follow the Git-flow model and deviate where it make sense for this project.

Gitflow Summary Turns out you just need to use the tag

Naming branches

Branches should follow the following naming convention to make it easy to figure out what issue the branch goes to along with what type of issue the branch is working on.

I think we should stick with the following tag names:

Naming convention:

<tag>/<projectNumber>-<dash-seperated-description>

Example:

feature/10-create-tree-component
jrussellfreelance commented 4 years ago

@Maddix what would the projectNumber be in that naming convention? You used 10 as an example. Does it increment?

Maddix commented 4 years ago

Every issue and PR is assigned an auto generated ID. Like this issue for instance:

image

You can refer to these issues and PRs automatically by prefixing the issue or PR number with a hash, like this #25