forked from comses-education/github-starter-course
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request comses-education#12 from hwelsters/hwelsters-patch-1
add tutorial on contributing back to this GitHub classroom repository using a basic GitHub flow
- Loading branch information
Showing
1 changed file
with
47 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -369,7 +369,7 @@ You can find a model of your choice from the [Netlogo Modeling Commons](http://m | |
|
|
||
| Once you have chosen and downloaded a Netlogo model, save the file to your local Github repository branch that you created. | ||
|
|
||
| As you may have already learned in the [Good Practices for Scientific Software Training Module](https://www.comses.net/education/responsible-practices/), code should always have documentation. Let's add some documentation to accompany your Netlogo model. | ||
| As you may have already learned in the [Responsible Practices for Scientific Software Training Module](https://www.comses.net/education/responsible-practices/), code should always have documentation. Let's add some documentation to accompany your Netlogo model. | ||
|
|
||
| Copy information about the model to a plain text document. The information can be the description stored in the `Info` tab in the Netlogo model. Or it can be the description that accompanied the model in its online archive. | ||
|
|
||
|
|
@@ -439,6 +439,52 @@ Make sure you've completed the following assignments: | |
| * (Optional) Go to your user dashboard and create a new repository to practice what you've learned here. Feel free to experiment! | ||
| * [Let us know what worked and what needs improvement in this lesson in the CoMSES Education forum](https://forum.comses.net/c/education/28). Was there anything confusing? What can we do better? If you'd like to submit feedback in private, please send an email to us at `[email protected]` | ||
|
|
||
| ## 💪 Contributing to the classroom repository | ||
|
|
||
| If you would like to improve this lesson, you can contribute to the classroom repository at https://github.com/comses-education/github-starter-course | ||
|
|
||
| Fork this repository on GitHub. You do that by clicking on `Fork`: | ||
|  | ||
|
|
||
| Usually your forks have the same name as the upstream repository so nothing needs to be changed here. Click on `Create fork`: | ||
|  | ||
|
|
||
| After forking the repository, you will be in your forked repository. Which looks something like this: | ||
|  | ||
|
|
||
| Make sure your forked repository is in sync with the upstream branch. You may need to do this periodically to ensure that your fork is up to date. You do that by clicking on `Sync fork`: | ||
|  | ||
|
|
||
| If your fork is out of date, this box will appear. You can compare the changes by clicking on `Compare`. Once you are satisfied with the changes, click on `Update Branch`: | ||
|  | ||
|
|
||
| Committing directly to your main branch is almost always a bad idea when submitting a pull request. There's several reasons for this: | ||
|
|
||
| * if any additional changes are merged into the upstream repository's main branch _before_ your pull request gets approved and merged, your main branch and pull request will become out of sync with the upstream repository and possibly in conflict. To resolve those conflicts you'll need to rewrite history using git rebase (or go the nuclear option and delete your fork and start over again after it gets merged). Sometimes a pull request can take time for maintainers to properly review and assess, and critical bugfixes may take priority over your pull request. | ||
| * if the maintainer(s) of the upstream repository decide to perform a squash and merge or rebase and merge your fork's main branch will get out of sync with the upstream repository, forcing you to delete/refork or rewrite history on your fork | ||
|
|
||
| In general, committing and pushing your changes onto a short lived feature branch gives you greater flexibility over how to manage and adjust your proposed changes. | ||
|
|
||
| With all that in mind, let's go ahead and create a new branch. You can do that by clicking on the GitHub web UI's branch dropdown or go to the GitHub web UI's branch screen by clicking on the `[number] branch`. [number] is the number of active branches in the repository. | ||
|  | ||
|
|
||
| You will be redirected to this page. You then create a new branch by clicking on `New branch` | ||
|  | ||
|
|
||
| This modal will pop up. Give your branch an informative name that clearly indicates its purpose under `Branch name` and then click on `Create branch` | ||
|  | ||
|
|
||
| Make whatever changes 🔨 you want to make, then commit and push them to your fork. Once you are satisfied with your changes, you should make a pull request! You do that by clicking on `Contribute` | ||
| <br/><br/> | ||
| A box will appear, click on `Open pull request` | ||
|  | ||
|
|
||
| Give your pull request a informative title and description. Once you are ready, click on `Create pull request` | ||
|  | ||
|
|
||
| The maintainer(s) of this repository will now be able to review your changes and provide feedback and guidance on your proposed contributions. You may need to add more commits or close and open a new pull request based on their feedback. | ||
| 🎉 Good job, you have just contributed to this repo 💪! | ||
|
|
||
| ## Additional Resources 📚 | ||
|
|
||
| * [Short video on the big picture basics of GitHub](https://www.youtube.com/watch?v=w3jLJU7DT5E&feature=youtu.be) | ||
|
|
||