Skip to content

Contribution Process.md

Latest commit

 

History

History
21 lines (18 loc) · 1.32 KB

Contribution Process.md

File metadata and controls

21 lines (18 loc) · 1.32 KB

Contributing

Our project use GitHub Flow for contributions. In short, Fork, Create a branch, submit a pull request from that branch.

Suggested repo setup

  1. Fork the repo
  2. Clone your fork (your fork will be origin)
  3. Add a remote named upstream to your local cloned repository
    • Command: git remote add upstream git@github.com:sevenwestmedia/processes.git
    • This allows you to push changes to your fork (origin), and pull changes from the main repo (upstream)

Workflow

  1. git checkout master
  2. git pull upstream master --ff-only - pulls the lastest changes from the main repository into your local master
  3. git checkout -b task/task-description
  4. ... do work
  5. git commit -m "SEMANTIC RELEASE COMMIT" - see Semantic Release commit format
    • eg. fix: Some bug fix, feat: Some feature description, docs(readme): Improved readme.
    • You can also put an extended description in a multiline commit message on line 3
  6. git push -u origin HEAD - This will push your current branch to your fork
  7. Open a pull request from your fork to the main repository (if you navigate to the main repository, GitHub will detect you have pushed a branch and suggest to open a pull request)