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

Document code review process at OKI #6

Merged
merged 4 commits into from
Feb 17, 2016
Merged

Document code review process at OKI #6

merged 4 commits into from
Feb 17, 2016

Conversation

pwalsh
Copy link
Member

@pwalsh pwalsh commented Feb 15, 2016

No description provided.


Submitting code for review should follow these steps:

1. Work out of your own fork of the main repository (usually `origin`).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that really necessary? You can submit PRs from the feature branch to the master branch even if the are in the same repo.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I usually do exactly as you describe. I'm easy.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think either is okay, as long as old feature branches are removed from the origin repo when no longer needed.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@brew yes that is the main annoying thing. In the last year I removed something like 20 branches from both OpenSpending and Open Data Census because people just merged PRs and left their mess around :)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we should add this to the coding-standards: It's the merger's responsibility to remove redundant feature branches.

btw - git cli can be useful for periodic branch pruning with git branch --merged and git branch --no-merged.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@brew thanks for the branch pruning tip!


## How

The process for code reviews is straight forward as long as you are already following our coding standards for working with version control, and in particular our git flow-influenced process of branch management. The bottom line is that, before any code hits `master`, it must be reviewed by a colleague.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

must is very strong. I still have concerns that this stricture doesn't fit in with all projects. Especially in the early stages of a new project.

pwalsh added a commit that referenced this pull request Feb 17, 2016
Document code review process at OKI
@pwalsh pwalsh merged commit abab759 into master Feb 17, 2016
@pwalsh pwalsh deleted the feature/reviews branch February 17, 2016 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants