Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update guide.md with instructor notes #73

Merged
merged 1 commit into from
Jul 16, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 %}
Loading