Fix: edits from review

Author: lwasser

images/license-github-root-dir.png

@@ -20,7 +20,8 @@ In this lesson you will learn:
 
 A license contains legal language about how users can use and reuse your software. You should include a LICENSE file in your project directory that specifies the license that you choose for your package.
 
-We suggest that you use a permissive license that accommodates the other most commonly used licenses in the scientific Python ecosystem (MIT[^mit] and BSD-3[^bsd3]).
+We suggest that you use a permissive license that accommodates the other most commonly used licenses in the scientific Python ecosystem (MIT[^mit] and BSD-3[^bsd3]). If you are unsure, use MIT given it's the generally recommended
+license on [choosealicense.com](https://choosealicense.com/).
 
 :::{admonition} Licenses for the scientific Python ecosystem
 [We discuss licenses for the scientific Python ecosystem in more detail here in our guidebook.](permissive-license)
@@ -29,6 +30,18 @@ We suggest that you use a permissive license that accommodates the other most co
 ### Where should the LICENSE file live & how do you add it?
 
 Your `LICENSE` file should be placed at the root of your package's repository.
+When you add the LICENSE at the root, GitHub will automagically discover it and
+provide users with a direct link to your license file within your GitHub
+repository.
+
+:::{figure-md} github-coc-readme-license-tabs
+<img src="../images/license-github-root-dir.png" alt="Image showing the GitHub repository for SunPy an accepted pyOpenSci package." width="500px">
+
+Notice at the top of the
+README portion of the GitHub landing page, there are three tabs directly linking to the README file which is visible, the CODE_OF_CONDUCT file and one that specifies
+the license that SunPy uses. These files are discovered by GitHub because they
+are placed in the root of the project directory using standard naming conventions.
+:::
 
 There are several ways to add a license file:
 
@@ -57,6 +70,7 @@ If you don't already have a LICENSE file, and you are not yet using a platform s
 # Create a license file in your shell
 > touch LICENSE
 ```
+
 1. Go to [choosealicense.com](https://choosealicense.com/)
 2. Select permissive license
 3. It will suggest that you use the [MIT license](https://choosealicense.com/licenses/mit/).
@@ -70,7 +84,6 @@ In the pyOpenSci [packaging guidebook](../documentation/repository-files/license
 If you want a broad overview of why licenses are important for protecting open source software, [check out this blog post that overviews the legal side of things.](https://opensource.guide/legal/#just-give-me-the-tldr-on-what-i-need-to-protect-my-project)
 :::
 
-
 ::::::{dropdown} Instructions for adding a license files within the GitHub interface
 :color: primary
 
@@ -89,13 +102,12 @@ Image showing the GitHub interface that allows you to add a LICENSE and README f
 :::
 ::::
 
-
 ::::{tab-item} Add License: Existing GitHub repository
 
-If you already have a GitHub repo for your package, then you can add a LICENSE using the GitHub interface by adding a new file to the repo.
+If you already have a GitHub repository for your package, then you can add a LICENSE using the GitHub interface by adding a new file to the repo.
 
-* Follow the instructions to select and add a license to your repository on the [GitHub LICENSE page](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository) .
-* Once you have added your LICENSE file, be sure to sync your git local repository with the repository on GitHub.com. This means running `git pull` to update your local branch.
+- Follow the instructions to select and add a license to your repository on the [GitHub LICENSE page](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository) .
+- Once you have added your LICENSE file, be sure to sync your git local repository with the repository on GitHub.com. This means running `git pull` to update your local branch.
 
 :::{figure-md} view-license
 <img src="../images/tutorials/view-license-github.png" alt="sdfsdfsd nasdfjsdf" width="500px">
@@ -110,7 +122,9 @@ You can also view a summary of the license on its GitHub landing page.```
 (add-coc)=
 ## Add a CODE_OF_CONDUCT file to your repo
 
-Now that you have added a LICENSE to your project, you are ready to add a file called `CODE_OF_CONDUCT.md` to your package directory. A `CODE_OF_CONDUCT` file is critical to supporting your community as it
+Now that you have added a LICENSE to your project, you are ready to add a `CODE_OF_CONDUCT.md` to your package directory. The `CODE_OF_CONDUCT.md` should be placed at the root of your project directory, similar to the LICENSE file,.
+
+A `CODE_OF_CONDUCT` file is critical to supporting your community as it
 grows. The `CODE_OF_CONDUCT`:
 
 1. Establishes guidelines for how users and contributors interact with each other and you in your software repository.
@@ -123,40 +137,39 @@ file, we suggest that you adopt the [contributor covenant language](https://www.
 
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](#)
 
-
 ### Add your CODE_OF_CONDUCT file
 
-* Add a `CODE_OF_CONDUCT.md` file to your repository if it doesn't
-already exist.
-* Visit the [contributor covenant website](https://www.contributor-covenant.org/) and add [the markdown version of their code of conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) to your `CODE_OF_CONDUCT.md` file.
-
+- Add a `CODE_OF_CONDUCT.md` file to your repository if it doesn't
+  already exist.
+- Visit the [contributor covenant website](https://www.contributor-covenant.org/) and add [the markdown version of their code of conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) to your `CODE_OF_CONDUCT.md` file.
 
 :::{admonition} Additional Code of Conduct resources
 :class: note
 
-* [<i class="fa-brands fa-github"></i> Guide: `CODE_OF_CONDUCT.md` files](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)
-* [pyOpenSci package guide `CODE_OF_CONDUCT.md` overview](https://www.pyopensci.org/python-package-guide/documentation/repository-files/code-of-conduct-file.html)
+- [<i class="fa-brands fa-github"></i> Guide: `CODE_OF_CONDUCT.md` files](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)
+- [pyOpenSci package guide `CODE_OF_CONDUCT.md` overview](https://www.pyopensci.org/python-package-guide/documentation/repository-files/code-of-conduct-file.html)
 
 :::
 
 ## <i class="fa-solid fa-hands-bubbles"></i> Wrap up
 
 In this lesson and the [last lesson](add-readme), you have added a:
 
-* `README` file;
-* `LICENSE` file and a
-* `CODE_OF_CONDUCT` file.
+- `README` file;
+- `LICENSE` file and a
+- `CODE_OF_CONDUCT` file.
 
-These are core files needed for every scientific Python package. In the upcoming
+These are fundamental files needed for every scientific Python package
+repository. These files help users understand how to use your package and
+interact with package maintainers. In the upcoming
 lessons, you will:
 
-* [Flesh out your `pyproject.toml` file](pyproject-toml) to support building
-and publishing your package on PyPI.
-* Publish a new version of your Python package to (Test) PyPI to preview the
-updated metadata landing page.
-
+- [Flesh out your `pyproject.toml` file](pyproject-toml) to support building
+  and publishing your package on PyPI.
+- Publish a new version of your Python package to (Test) PyPI to preview the
+  updated metadata landing page.
 
-****
+---
 
 ## Footnotes
 

tutorials/add-license-coc.md

@@ -1,10 +1,11 @@
 # Publish your Python package to PyPI
 
 :::{todo}
-* emphasize that we recommended the trusted publisher GitHub action for most maintainers
-* Make sure they add /dist to their .gitignore file. We have not discussed GitHub workflows anywhere yet. Where does that fit?
-* https://hatch.pypa.io/latest/intro/#existing-project <- hatch will migrate from setup.py for you - if we go with hatch then we may want to add this to the installable code lesson
-* Should we install hatch with pipx?
+
+- emphasize that we recommended the trusted publisher GitHub action for most maintainers
+- Make sure they add /dist to their .gitignore file. We have not discussed GitHub workflows anywhere yet. Where does that fit?
+- https://hatch.pypa.io/latest/intro/#existing-project <- hatch will migrate from setup.py for you - if we go with hatch then we may want to add this to the installable code lesson
+- Should we install hatch with pipx?
 
 ```bash
 pipx install hatch
@@ -51,7 +52,6 @@ You will learn how to publish to conda-forge in the [next lesson](7-publish-cond
 You need to build your Python package in order to publish it to PyPI (or Conda). The build process organizes your code and metadata into a distribution format that can be uploaded to PyPI and subsequently downloaded and installed by users.
 :::
 
-
 ## Test PyPI vs PyPI
 
 There are two "warehouses" that you can use to publish
@@ -76,13 +76,13 @@ to PyPI. You need to:
 1. **Create an account on (test) PyPI**: You will need to create a PyPI account and associated token which provides permissions for you to upload your package.
 1. **Publish to PyPI using `hatch publish`**
 
-
 In a future lesson, you will learn how to create an automated
 GitHub action workflow that publishes an updated
 version of your package to PyPI every time you create a GitHub release.
 
 :::{admonition} Learn more about building Python packages in our guide
 :class: tip
+
 - [Learn more about what building a Python package is](../package-structure-code/python-package-distribution-files-sdist-wheel)
 - [Learn more about package distribution file that PyPI needs called the wheel](#python-wheel)
 - [Learn more about the package distribution file that conda-forge will need on PyPI called the sdist (source distribution)](#python-source-distribution)
@@ -139,7 +139,6 @@ six             1.16.0
 tzdata          2023.4
 ```
 
-
 At any time you can exit the environment using `exit`.
 
 ```bash
@@ -154,13 +153,13 @@ pyosPackage (☊ main) [✎ ×1 ] is 📦 v0.1.4 via 🐍 pyenv took 43s
 ➜
 ```
 
-
 ### Hatch and environments
 
 Behind the scenes when hatch creates a new virtual environment,
 by default it uses venv[^venv] which is the default environment management tool that comes with Python installations.
 
 Hatch will:
+
 1. Create a new virtualenv (venv) that is located on your computer.
 2. Install your package into the environment in editable mode (similar to `pip install -e`). This means it installs both your project and your project's dependencies as declared in your pyproject.toml file.
 
@@ -232,8 +231,8 @@ Example: `pyosPackage_yourNameHere`.
 Show them how to do this
 
 1. update the project-name in the pyproject.toml file
-2. update the module repo directory to be the same
-:::
+2. update the module repository directory to be the same
+   :::
 
 :::{figure-md} build-workflow-tutorial
 <img src="../images/tutorials/testpypi-search.png" alt="This is a screenshot of the test PyPI website. At the top in the search bar, you can see the search for pyosPackage. The search return says there were no results for pyosPackage Did you mean probpackage" width="700px">
@@ -242,7 +241,6 @@ Before you try to upload to test PyPI, check to see if the name of your package
 the search box at the top of the test PyPI website.
 :::
 
-
 :::{admonition} Setup 2-factor (2FA) authentication
 
 2-factor authentication is a secure login process that allows you to
@@ -268,12 +266,11 @@ It's ideal to create a package-specific token. When you create an account wide t
 
 ### Follow the steps below to create your token.
 
-* Login to test PyPI and go to your account settings
-* Scroll down to the **API tokens** section
-* Click on the **Add API Token** button
-     * If you are new to using PyPI and don't have any packages there yet, OR if you have other packages on PyPI but are uploading a new package, you will need to create an account-wide token.
-* When you create your token, be sure to copy the token value and store it in a secure place before closing that browser.
-
+- Login to test PyPI and go to your account settings
+- Scroll down to the **API tokens** section
+- Click on the **Add API Token** button
+  - If you are new to using PyPI and don't have any packages there yet, OR if you have other packages on PyPI but are uploading a new package, you will need to create an account-wide token.
+- When you create your token, be sure to copy the token value and store it in a secure place before closing that browser.
 
 Your token should look something like this:
 
@@ -286,12 +283,12 @@ It should start with `pypi` followed by a dash and a bunch of characters.
 Once you have your token, you are ready to publish to
 PyPI.
 
-* Run `hatch publish -r test`
+- Run `hatch publish -r test`
 
 `-r` stands for repository. In this case because you are publishing to test-PyPI you will use `-r test`. Hatch will then ask for a username and credentials.
 
-* Add the word `__token__` for your username. This tells Test PyPI that you are using a token value rather than a username.
-* Paste your PyPI token value in at the `Enter your credentials` prompt:
+- Add the word `__token__` for your username. This tells Test PyPI that you are using a token value rather than a username.
+- Paste your PyPI token value in at the `Enter your credentials` prompt:
 
 ```bash
 ❯ hatch publish -r test
@@ -321,7 +318,6 @@ landing page for your newly uploaded package.
 This is an example landing page for the pyosPackage that was just uploaded. Notice at the top of the page there is instruction for how to install the package from test PyPI. You can simply copy that code and use it to install your package from testPyPi locally.
 :::
 
-
 As an example, [check out our pyOpenSci pyosPackage landing page on test PyPI](https://test.pypi.org/project/pyosPackage/). Notice that
 the page has information about the current package version and also
 installation instructions as follows:
@@ -335,9 +331,9 @@ testPyPI as a permanent way to install your package. Test PyPi is a perfect plac
 
 ### Time to install your package
 
-* On your computer, activate the development environment that
-you wish to install your newly published package in.
-* Run the installation instructions for your package from test PyPI.
+- On your computer, activate the development environment that
+  you wish to install your newly published package in.
+- Run the installation instructions for your package from test PyPI.
 
 ::::{tab-set}
 
@@ -348,9 +344,11 @@ you wish to install your newly published package in.
 > pip install -i https://test.pypi.org/simple/ youPackageNameHere
 > conda list
 ```
+
 :::
 
 :::{tab-item} venv mac / Linux
+
 ```bash
 > hatch shell
 > pip install -i https://test.pypi.org/simple/ youPackageNameHere
@@ -412,3 +410,4 @@ You will learn how to do that in the next lesson.
 ## Footnotes
 
 [^venv]: https://docs.python.org/3/library/venv.html
+```