OHDSI Home | Forums | Wiki | Github

RFC: Developer guide to using Git and GitHub

Developers
#1

Hello, Developers,
We’ve been working on refreshing the documentation for guiding devs on using git to create pull requests and managing code. The document can be found here in the ohdsi wiki:
http://www.ohdsi.org/web/wiki/doku.php?id=development:ohdsi_github_projects_v2

I’d like to petition anyone who is interested in commenting on this article. It doesn’t cover release procedures, just the maneuvers involved in contributing code as an internal/external collaborator. If comments could be left here, we can try to improve it or address concerns/clarifications in the material.

Thank you.

-Chris

1 Like
#2

Thanks @Chris_Knoll. This is great and will be helpful to many. I reviewed and it seems fine for now. I may have more comments when the release management doc comes out :slight_smile:

#3

Thank you for creating those. (and I am sorry about past violation of these rules) :frowning:

To address/reduce commit noise, a possible approach is to combine all branch/fork commits into a single one.

This can be done even via web here:

Pasted image514×545 30.1 KB

And nice article about it is here:
http://emmanuelsanmiguel.com/squashing-git-commits-to-reduce-noise/

#4

Yep, definitely recommend that we use sqash and merge when pulling in the pull request.

Separately, a Pull Request should be re-made if it becomes out of date with the master (ie: there are X commits behind master and Y commits ahead of master). To bring the PR up to date with the latest master, rebasing is an option. Or you can merge master into your PR branch, and then test the code because something in master may have impacted you. I know the risk is potentially low, but it’s just good diligence to check your branch for non-breaking changes after master is updated.

And @Vojtech_Huser, don’t worry about past rule violations, these guidelines were just published so everyone has a clean slate :slight_smile: But going forward… :wink: :wink:

-Chris

#5

If there’s no further comments on this article, I’d like to update the wiki references to point to this new article for the ‘working with GitHup projects’ in the OHDSI page found here:
http://www.ohdsi.org/web/wiki/doku.php?id=development:guidelines

I can change the link for “OHDSI GitHub Projects” to go to this link.

t