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

branching/forking wiki page #21

Open
benjamin-hicks-cdph-ca-gov opened this issue Aug 6, 2018 · 1 comment
Open

branching/forking wiki page #21

benjamin-hicks-cdph-ca-gov opened this issue Aug 6, 2018 · 1 comment

Comments

@benjamin-hicks-cdph-ca-gov
Copy link
Collaborator

Contributors can't add new wiki pages (only edit current pages), but I think the following wiki page (with your preferred edits) would be helpful regarding branching and forking:

In keeping with standard GITHUB practice, CCB has adopted two procedures to contribute to the projects modular code.

  1. For contributors making changes to one file of the CCB, or contributors who plan to have limited edits applied in a limited amount of time, or contributors working in a collaborative sub-team to edit 1-2 files, forking of the CACommunityBurden repository is suggested. This is primarily to capture the final product in version control. To proceed:
    a. The contributor will make a github account.
    b. From the CCB repository page (https://github.com/mcSamuelDataSci/CACommunityBurden), the contributor will Fork the Repository by selecting the Fork option in the top right corner. After the repository is generated, the contributor will rename the forked repository with their initials (eg. CACommunityBurden-MI) by selecting the Settings tab under the repository names.
    c. The contributor can now edit the desired file in their forked copy of the repository. For general steps to set-up the repository in R see here. Contributors will map to the forked repository url instead of the CCB repository (https://github.com/mcSamuelDataSci/CACommunityBurden). When making edits, contributors will stay on the master branch.
    d. Pull requests can be made and merged in the master branch of the forked repository as necessary.
    e. When all edits are done to the desired 1-2 files, the contributing repository owner will use the "New pull request" button found on the Code tab. The defualt compare changes menu should display the the main repository and the forked repository. Create a pull request to merge repositories on github
    f. The main repository owner (Michael Samuel) will review the suggested changes in R by mapping directly to the contributors URL.
    g. If the changes are accepted, the repository owner will accept the changes on the Github website and the forked repository will need to be deleted by the contributor.

  2. For contributors making changes to more than one file of the CCB, or contributors who plan to have on-going edits applied in an extended amount of time, or contributors working in a collaborative sub-team to edit 3+ files, branching of the CACommunity repository is suggested. This is primarily to capture the on-going editing process in version control. To proceed:
    a. Request to be added as a collaborator. A branch will be created by the main repository owner (Michael Samuel).
    b. The contributor can now edit the desired file in their branched copy of the repository. For general steps to set-up the repository in R see here.
    c. When edits are done to the desired file, the branch owner will use the "New pull request" botton found on the Code tab. Alternatively a pull request can be created in R.
    d. The main repository owner (Michael Samuel) will review the suggested changes in R by reviewing the contributors branch.
    e. If the changes are accepted, the repository owner will accept the changes and assess if the branch needs to be deleted.

If a branch/fork stays open for an extended amount of time, it is up to the contributor to update their branch/fork with the most recent CCB repository files by creating a pull request from the main CCB repository to the branch/fork.

@mcSamuelDataSci
Copy link
Owner

I've created a new wiki page based on this. I have not yet reviewed it carefully, but will soon.

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

No branches or pull requests

2 participants