search

multar / gh

:octocat: Guidelines for GitHub organization.
MIT License
0 stars 0 forks source link

Contribution guidelines #2

Open sandro-guest opened 5 years ago

sandro-guest commented 5 years ago

Define standard practices for effective development and communication

Should address the following aspects (not-exhaustive)

General development

Coding and documentation

Meta

Check available examples and guides for valuable content and log notable references for exploration.

Create separate issue if a topic needs advanced elaboration.

Context > Need this to start a development project ASAP, so rough definitions are preferred to best lyrical content as long as they communicate enough. Initially required: - Branching model - Commit messages Following should be derived when some development happens: - Code organization - Common practices - Style guide The rest can be added later.
sandro-guest commented 5 years ago
sandro-guest commented 5 years ago

HubFlow branching strategy

Much complex than needed, but good illustration of total flow

HubFlow diagram

sandro-guest commented 5 years ago

https://gist.github.com/jbenet/ee6c9ac48068889b0912 - Sensible opinionated style guide.

sandro-guest commented 5 years ago

https://en.wikipedia.org/wiki/Atomic_commit#Atomic_Commit_Convention - for incremental, atomic changes

sandro-guest commented 5 years ago