Skip to content

Commit

Permalink
feat: update guide.md with instructor notes (#73)
Browse files Browse the repository at this point in the history
Add a bit of explanation about why the lesson is structured as it is.
This is mostly intended for the instructors who come after, so they
don't misstep like I did.

- resolves #30
  • Loading branch information
hollandjg authored Jul 16, 2024
1 parent adc7289 commit 892a7c8
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,25 @@
---
title: "Instructor Notes"
---
FIXME
This lesson is a process-oriented tutorial on creating a Python package for Research Software Engineers.

After giving an overview of all the files we're going to touch (on the index page),
it follows the process of creating a package:
- Create a new repository (setup),
- Create a virtual environment,
- Add some code and tests,
- Add important metadata files,
- Configure the `pyproject.toml` file with detailed metadata,
- Decide on and implement a versioning scheme,
- Add automated checks like code linting,
- Add continuous integration support,
- Publish the package and make it citeable by adding an additional metadata file.

The lesson is intentionally more challenging than an entry-level how-to guide on packaging.
At each step when a new concept is introduced,
it dives deeper into the detail than a how-to guide would –
for instance, we only get to code after setting up an environment
and initializing the infrastructure needed for reproducible builds.


{% include links.md %}

0 comments on commit 892a7c8

Please sign in to comment.