Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve branching scheme with branch for each guide, not for each author #58

Closed
durden opened this issue May 3, 2016 · 0 comments
Closed

Comments

@durden
Copy link
Contributor

durden commented May 3, 2016

Currently we create branches automatically when a user edits someone else's guide. This is working pretty well. However, it makes merging changes difficult when an editor has edits for more than 1 guide at a time. We should make a new branch for every guide. Then, creating PRs and merging requests only deals with 1 guide at a time.

The caveat we need to think through here is that we currently use the editor name as the name of the branch. This is the only way we know who is editing which guide. So, we need to either create new branches with something like <editor_name>-<stack>-<title> or some other scheme. This way we encode the guide ID (stack/title) and editor name in the name of the branch. This makes sure we don't have to store the editor name anywhere since it's always embedded in the branch name.

durden added a commit that referenced this issue May 5, 2016
- This allows us to keep a new branch for every guide.  This way it's easier to
  merge changes when an editor is working on more than 1 branch at a time.
- This will also make it easier to make pull requests later since each branch
  is focused on only 1 guide.

- Fixes #58.
durden added a commit that referenced this issue May 5, 2016
- This allows us to keep a new branch for every guide.  This way it's easier to
  merge changes when an editor is working on more than 1 branch at a time.
- This will also make it easier to make pull requests later since each branch
  is focused on only 1 guide.

- Fixes #58.
@durden durden closed this as completed in c9c412c May 5, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant