Shopify / Shopify/toxiproxy

Separate development from master branch

Open
#146 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
12.4k
Forks
510
PR merge metrics
No merged PRs in 30d

Description

Recently it seems there's been some issues and confusion over what versions are released and what documentation matches what.

Currently the master README.md is a bit of a mix between 2.0.0 documentation and upcoming 2.1.0 changes.
I think it may be beneficial to move 2.1.0 development to a dev branch, so that master is always the most recent release, and has the corresponding documentation.
This also makes staging README changes much easier for future releases.

Thoughts?
@Sirupsen

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the current master README.md and the issue's proposed separation between released 2.0.0 documentation and upcoming 2.1.0 changes. Confirm the desired branch policy with maintainers; done would mean master tracks the latest release and its documentation while dev contains the next release work.

Written by the indexing model from the issue text.

Assessment

Tech stack
git
Domain
developer-experience, documentation, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.