Merge branch 'license-pyproject' of https://github.com/lwasser/python-package-guide into license-pyproject

# Conflicts:
#	tutorials/add-license-coc.md
#	tutorials/add-readme.md
#	tutorials/intro.md
#	tutorials/pyproject-toml.md

Author: sneakers-the-rat

.all-contributorsrc

@@ -450,6 +450,17 @@
         "review",
         "tutorial"
       ]
+    },
+    {
+      "login": "xmnlab",
+      "name": "Ivan Ogasawara",
+      "avatar_url": "https://avatars.githubusercontent.com/u/5209757?v=4",
+      "profile": "https://xmnlab.github.io",
+      "contributions": [
+        "code",
+        "review",
+        "tutorial"
+      ]
     }
   ],
   "contributorsPerLine": 7,

README.md

@@ -1,6 +1,6 @@
 # <img src="https://www.pyopensci.org/images/logo.png" width=100 /> pyOpenSci scientific Python Packaging Guide
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-43-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-44-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 ![GitHub release (latest by date)](https://img.shields.io/github/v/release/pyopensci/python-package-guide?color=purple&display_name=tag&style=plastic)
@@ -130,6 +130,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     </tr>
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/h-vetinari"><img src="https://avatars.githubusercontent.com/u/33685575?v=4?s=100" width="100px;" alt="h-vetinari"/><br /><sub><b>h-vetinari</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=h-vetinari" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Ah-vetinari" title="Reviewed Pull Requests">👀</a> <a href="#tutorial-h-vetinari" title="Tutorials">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://xmnlab.github.io"><img src="https://avatars.githubusercontent.com/u/5209757?v=4?s=100" width="100px;" alt="Ivan Ogasawara"/><br /><sub><b>Ivan Ogasawara</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=xmnlab" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Axmnlab" title="Reviewed Pull Requests">👀</a> <a href="#tutorial-xmnlab" title="Tutorials">✅</a></td>
     </tr>
   </tbody>
 </table>

documentation/repository-files/license-files.md

@@ -47,7 +47,7 @@ To select your license, we suggest that you use GitHub's
 [Choose a License tool ](https://choosealicense.com/).
 
 If you choose your license when creating a new GitHub repository, you can also
-automatically get a text copy of the license file to add to your repo. However
+automatically get a text copy of the license file to add to your repository. However
 in some cases the license that you want is not available through that online
 process.
 
@@ -78,9 +78,9 @@ with the license that you selected for your package.
 :::{admonition} An example of how a license determine how code can be reused
 :class: note
 
-Let's use stackOverflow as an example that highlights how a license determines how code can or can not be used.
+Let's use StackOverflow as an example that highlights how a license determines how code can or can not be used.
 
-[Stack overflow uses a Creative Commons Share Alike license.](https://stackoverflow.com/help/licensing). The sharealike license requires you to use the same sharealike license when you reuse any code from stackoverflow.
+[Stack overflow uses a Creative Commons Share Alike license.](https://stackoverflow.com/help/licensing). The sharealike license requires you to use the same sharealike license when you reuse any code from StackOverflow.
 
 This means that technically, if you copy code from the Stack Overflow website, and use it in your package. And your packages uses a different license such as a MIT license, you are violating Stack Overflow's license requirements!
 
@@ -92,7 +92,7 @@ This means that technically, if you copy code from the Stack Overflow website, a
 
 While many permissive licenses do not require citation we STRONG encourage that you cite all software that you use in papers, blogs and other publications. You tell your users how to cite your package by using a [citation.cff file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files). We will cover this topic when we talk about creating DOI's for your package using zenodo.
 
-<!-- TODO: add link when lesson is created - but also we don't yet know how citation.cff files work with zenodo (do they work??) will the citation info update with a new zenodo link
+<!-- TODO: add link when lesson is created - but also we don't yet know how citation.cff files work with Zenodo (do they work??) will the citation info update with a new Zenodo link
 
 These files - we need to understand if that date releases auto populates or forces zenodo to modify it's citation. if it's not dynamic it could be problematic
 

images/tutorials/view-license-github.png

@@ -48,13 +48,13 @@ Click here for a tutorial on publishing your package to PyPI.
 :::
 
 
-```{tip}
+:::{tip}
 On the package build page, we discussed the [two package distribution
 types that you will create when making a Python package](python-package-distribution-files-sdist-wheel): SDist (packaged as a .tar.gz or .zip) and
 Wheel (.whl) which is really a zip file. Both of those file "bundles" will
 be published on PyPI when you use [a standard build tool](python-package-build-tools) to build
 your package.
-```
+:::
 
 (about-conda)=
 ## What is Anaconda Cloud and conda?
@@ -69,8 +69,6 @@ packages. These repositories are known as channels (discussed below).
 :::{admonition} A brief history of conda's evolution
 :class: note
 
-The conda ecosystem evolved years ago to provide support for and
-simplify the process of managing software dependencies in scientific
 The conda ecosystem evolved years ago to provide support for, and
 simplify the process of, managing software dependencies in scientific
 Python projects.
@@ -156,11 +154,11 @@ to use conda to manage their local environments (which many do), you should
 consider publishing to both PyPI and the conda-forge channel (_more
 on that below_).
 
-```{admonition} Additional resources
-* [learn more about why conda-forge was created, here](https://conda-forge.org/docs/user/introduction.html#why-conda-forge)
+:::{admonition} Additional resources
+* [learn more about why conda-forge was created, here](https://conda-forge.org/docs/user/introduction.html)
 
 * [To learn more about conda terminology, check out their glossary.](https://docs.conda.io/projects/conda/en/latest/glossary.html )
-```
+:::
 
 <!-- One of our packages on conda-forge https://anaconda.org/conda-forge/pandera -->
 
@@ -171,7 +169,7 @@ we encourage you to consider doing so!
 
 Once your package is on PyPI, the process to add your package to conda-forge
 is straight forward to do. [You can follow the detailed steps provided
-by the conda-forge maintainer team.](https://conda-forge.org/docs/maintainer/adding_pkgs.html#generating-the-recipe).
+by the conda-forge maintainer team.](https://conda-forge.org/docs/maintainer/adding_pkgs.html).
 
 
 :::{button-link} ../tutorials/publish-conda-forge.html
@@ -186,9 +184,9 @@ If you want a step by step tutorial, click here.
 
 Once your package is added, you will have a feedstock repository on GitHub with your packages name
 
-```{tip}
+:::{tip}
 [Here is an example conda-forge feedstock for the pyOpenSci approved package - movingpandas](https://github.com/conda-forge/movingpandas-feedstock)
-```
+:::
 
 ### Maintaining your conda-forge package repository
 

package-structure-code/publish-python-package-pypi-conda.md

@@ -16,18 +16,25 @@ In this lesson you will learn:
 3. How you can use the Contributors Covenant website to add generic language as a starting place for your `CODE_OF_CONDUCT`.
 :::
 
-## Add a LICENSE file to your project directory
+## What is a license?
 
-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.
+A license contains legal language about how users can use and reuse your software. To set the LICENSE for your project, you:
+
+1. create LICENSE file in your project directory that specifies the license that you choose for your package and
+2. reference that file in your pyproject.toml data where metadata are set.
+
+By adding the LICENSE file to your pyproject.toml file, the LICENSE will be included in your package's metadata which is used to populate your package's PyPI landing page. The LICENSE is also used in your GitHub repository's landing page interface.
+
+### What license should you use?
 
 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)
+[We discuss licenses for the scientific Python ecosystem in more detail here in our guidebook.](../documentation/repository-files/license-files)
 :::
 
-### Where should the LICENSE file live & how do you add it?
+### Where should the LICENSE file live
 
 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
@@ -43,7 +50,10 @@ 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:
+
+### How to add a LICENSE file to your package directory
+
+There are several ways to add a LICENSE file:
 
 1. When you create a new repository on GitHub, it will ask you if you wish to add a `LICENSE` file at that time. If you select yes, it will create the file for you.
 2. You can add a license through the GitHub gui following the [<i class="fa-brands fa-github"></i> instructions here](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository).
@@ -60,11 +70,11 @@ then you already have a **LICENSE** file containing text for the MIT license in
 If you don't yet have a **LICENSE** file in your directory, then continue reading.
 :::
 
-### How to add a LICENSE to your existing GitHub repository
+### How to add a LICENSE to your package - the manual way
 
 If you don't already have a LICENSE file, and you are not yet using a platform such as GitHub or GitLab, then you can create a license file by
 
-1. Create a new file called LICENSE. If you are using a shell you can use:
+1. Create a new file called LICENSE. If you are using shell you can type:
 
 ```
 # Create a license file in your shell
@@ -75,6 +85,7 @@ If you don't already have a LICENSE file, and you are not yet using a platform s
 2. Select permissive license
 3. It will suggest that you use the [MIT license](https://choosealicense.com/licenses/mit/).
 4. Copy the license text that it provides into your LICENSE file that you created above.
+5. Save your file. You're all done!
 
 :::{admonition} An overview of LICENSES in the scientific Python ecosystem
 :class: note
@@ -96,52 +107,67 @@ through the GitHub interface.
 
 :::{figure-md} github-new-repo
 
-<img src="../images/tutorials/github-new-repo.png" alt="Screenshot of the create new repository interface that GitHub provides. The elements of this are the owner and repository name for the new repo. Below that you can add a description of the repo. Below that you can set it to be public or private. At the bottom of the interface there is an Add a README checkbox where it will add a blank readme file for you. At the very bottom there is a line to add a .gitignore file and another to choose a license." width="500px">
+<img src="../images/tutorials/github-new-repo.png" alt="Screenshot of the create new repository interface that GitHub provides. The elements of this are the owner and repository name for the new repo. Below that you can add a description of the repository. Below that you can set it to be public or private. At the bottom of the interface there is an Add a README checkbox where it will add a blank readme file for you. At the very bottom there is a line to add a .gitignore file and another to choose a license." width="500px">
 
 Image showing the GitHub interface that allows you to add a LICENSE and README file when you create a new repository.
 :::
 ::::
 
 ::::{tab-item} Add License: Existing GitHub repository
 
-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.
+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 repository.
 
 - 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">
+<img src="../images/tutorials/view-license-github.png" alt="Image showing what the LICENSE file looks like in the GItHub interface. At the top you can see the actual license which in this image is BSD 3-clause New or revised license. Then there is some text describing both what the license is and the associated permissions for that specific license. At the bottom of the image, the actual text for the license is shown in the LICENSE file." width="500px">
 
-You can also view a summary of the license on its GitHub landing page.```
+You can view a summary of the LICENSE chosen on your project's
+GitHub landing page.
 :::
 ::::
 
 :::::
 ::::::
 
+Now you know how to add a LICENSE to your project. Next, you'll learn
+about the `CODE_OF_CONDUCT.md` file and how to add it to your
+package directory.
+
 (add-coc)=
-## Add a CODE_OF_CONDUCT file to your repo
+## What is a code of conduct file?
 
-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 used to establish guidelines for how people in your community interact.
 
-A `CODE_OF_CONDUCT` file is critical to supporting your community as it
+This 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.
 2. Identifies negative behaviors that you don't want in your interactions.
 
 You can use your code of conduct as a tool that can be referenced when moderating challenging conversations.
 
+### What to put in your code of conduct file
+
 If you are unsure of what language to add to your `CODE_OF_CONDUCT`
 file, we suggest that you adopt the [contributor covenant language](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) as a starting place.
 
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](#)
 
-### Add your CODE_OF_CONDUCT file
+The `CODE_OF_CONDUCT.md` should be placed at the root of your project directory, similar to the LICENSE 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.
+### How to add a CODE_OF_CONDUCT file to your package directory
+
+- Add a `CODE_OF_CONDUCT.md` file to the root of your repository if it doesn't already exist.
+
+```bash
+> touch CODE_OF_CONDUCT.md
+```
+
+- 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. Read the text closely to ensure you both understand it and also agree with its contents!
+
+That's it - you've now added a code of conduct to your package directory.
 
 :::{admonition} Additional Code of Conduct resources
 :class: note
@@ -161,11 +187,11 @@ In this lesson and the [last lesson](add-readme), you have added a:
 
 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:
+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.
+- [Add more metadata to 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.