Skip to content

Commit cc623bb

Browse files
committed
Expand TOC, add Licensing section
1 parent ac53081 commit cc623bb

File tree

1 file changed

+34
-9
lines changed

1 file changed

+34
-9
lines changed

git-guide/git-guide.md

+34-9
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,22 @@ There is a rich Git community online. In addition to this guide you can use Goog
88

99
# Table of Contents
1010

11-
**[What is Git?](#what-is-git)**<br>
12-
**[Vocabulary](#vocabulary)**<br>
13-
**[Installation](#installation)**<br>
14-
**[Starting a Project](#starting-a-project)**<br>
15-
**[Stage, Commit, Push](#stage-commit-push)**<br>
16-
**[Collaboration on Code](#collaboration-on-code)**<br>
17-
**[Special Considerations](#special-considerations)**<br>
11+
* **[What is Git?](#what-is-git)**
12+
* **[Vocabulary](#vocabulary)**
13+
* **[Installation](#installation)**
14+
* [Best Practice Toolset](#best-practice-toolset)
15+
* **[Starting a Project](#starting-a-project)**
16+
* **[Stage, Commit, Push](#stage-commit-push)**
17+
* **[Collaboration on Code](#collaboration-on-code)**
18+
* [Resolve Merge Conflicts](#resolve-merge-conflicts)
19+
* **[Special Considerations](#special-considerations)**
20+
* [.gitIgnore](#gitignore)
21+
* [Non-Text Files](#non-text-files)
22+
* [Moving/Renaming a File](#moving-renaming-a-file)
23+
* [Save Password in Git Bash](#save-password-in-git-bash)
24+
* [Repository Not Found](#repository-not-found)
25+
* [Clearing Sensitive Data](#clearing-sensitive-data)
26+
* [Choosing an Open-Source License](#choosing-an-open-source-license)
1827

1928
# What is Git?
2029

@@ -354,7 +363,7 @@ If you must change names, make sure to **do the name change in its' own commit**
354363

355364
Then, stage and commit changes separately. That way you can actually see the changes line by line. If you do both in one commit, it'll show the old file being deleted and the new different file being added, with no line-by-line comparison.
356365

357-
## Password Setup in Git Bash
366+
## Save Password in Git Bash
358367

359368
You’ll want to save your password in Git Bash so you won’t have to type it every time you push or pull. Saving this way will also save it for VS Code.
360369

@@ -399,4 +408,20 @@ git gc --prune=now
399408
```
400409

401410
* This may take a while to run. Once it is finished, push to the remote repo. You may need to push with the -force keyword.
402-
* Add your file with sensitive data to a .gitignore file to ensure that you don't accidentally commit it again.
411+
* Add your file with sensitive data to a .gitignore file to ensure that you don't accidentally commit it again.
412+
413+
# Choosing an Open-Source License
414+
415+
*This guide is not legal support. Please work with your legal support when choosing a license.*
416+
417+
You may decide to use GitHub or Bitbucket to share your project publicly. When you contribute a new project to the open-source community, it is important to choose the correct license. In addition to this guide, you can refer to these great articles:
418+
419+
* https://opensource.guide/legal/
420+
* https://choosealicense.com/
421+
422+
Here are some high-level things to watch out for:
423+
424+
* The MIT license is a good one to start with because it is simple and permissive.
425+
* Check the license of any dependencies your code relies on. Some licenses require dependent projects to have specific licenses. This is called *copyleft*.
426+
* Many R packages are licensed as GPL which requires that all dependent projects also use GPL. If your project relies on R packages it is likely they are GPL and therefore you must use the GPL license. Python does not typically have this restriction.
427+
* If you expect external contributors, consider Apache Commons 2.0. This license may be better if you want to build a community around your project and you aren't relying on any copyleft projects that restrict your choice of license.

0 commit comments

Comments
 (0)