Add: last files for bug bash

Author: lwasser

images/tutorials/github-new-repo.png

@@ -0,0 +1,164 @@
+# Add a LICENSE & CODE_OF_CONDUCT to your Python package
+
+In the [previous lesson](add-readme) you:
+
+<i class="fa-solid fa-circle-check" style="color: #703c87;"></i> Created a basic `README.md` file for your scientific Python package
+
+<i class="fa-solid fa-circle-check" style="color: #703c87;"></i> Learned about the core components that are useful to have in a README file.
+
+:::{admonition} Learning objectives
+:class: tip
+
+In this lesson you will learn:
+
+1. How to select and add a `LICENSE` file to your package repository with a focus on the GitHub interface.
+2. How to add a `CODE_OF_CONDUCT` file to your package repository.
+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
+
+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]).
+
+:::{admonition} Licenses for the scientific Python ecosystem
+[We discuss licenses for the scientific Python ecosystem in more detail here in our guidebook.](permissive-license)
+:::
+
+### 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.
+
+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. It will also 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).
+3. You can add the file manually like we are doing in this lesson.
+
+:::{tip}
+If you completed the past lessons including
+
+1. [Making your code installable](1-installable-code.md) and
+2. [publishing your package to PyPI](publish-pypi.md)
+
+then you already have a **LICENSE** file containing text for the MIT license in your Python package. Thus you can skip to the next section of this tutorials which walks you through adding a CODE_OF_CONDUCT.
+
+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
+
+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 shell you can use:
+
+```
+# 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/).
+4. Copy the license text that it provides into your LICENSE file that you created above.
+
+:::{admonition} An overview of LICENSES in the scientific Python ecosystem
+:class: note
+
+In the pyOpenSci [packaging guidebook](../documentation/repository-files/license-files), we provide an overview of license in the scientific Python ecosystem. We review why license files are important, which ones are most commonly used for scientific software and how to select the correct 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
+
+:::::{tab-set}
+
+::::{tab-item} Add license: new GitHub repository
+
+When you create a new GitHub repository you can add a license
+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">
+
+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 repo 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.
+
+:::{figure-md} view-license
+<img src="../images/tutorials/view-license-github.png" alt="sdfsdfsd nasdfjsdf" width="500px">
+
+You can also view an overview of the license on GitHub if you view it in the GitHub interface.
+:::
+::::
+
+:::::
+::::::
+
+(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
+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.
+
+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
+
+* 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-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.
+
+These are core files needed for every scientific Python package. 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.
+
+
+****
+
+## Footnotes
+
+[^mit]: https://opensource.org/license/mit/
+[^bsd3]: https://opensource.org/license/bsd-3-clause/

tutorials/add-license-coc.md

@@ -33,7 +33,7 @@ Get to know Hatch <get-to-know-hatch>
 
 :::{toctree}
 :hidden:
-:caption: Create a Python package
+:caption: Create a Python Package
 
 What is a Python package? <self>
 Make your code installable <1-installable-code>
@@ -43,9 +43,11 @@ Publish to conda-forge <publish-conda-forge>
 
 :::{toctree}
 :hidden:
-:caption: Project Metadata
+:caption: Citation, License & Project metadata
 
 Add README file <add-readme>
+Add a license & COC <add-license-coc>
+Update metadata <pyproject-toml>
 :::
 
 :::{admonition} Learning Objectives