generated from carpentries/workbench-template-md
-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
629fbc9
commit 8f76efd
Showing
1 changed file
with
49 additions
and
83 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,83 +1,49 @@ | ||
| # The Carpentries Workbench Template Markdown Lesson | ||
|
|
||
| This lesson is a template lesson that uses [The Carpentries Workbench][workbench]. | ||
|
|
||
| ## Note about lesson life cycle stage | ||
| Although the `config.yaml` states the life cycle stage as pre-alpha, **the template is stable and ready to use**. The life cycle stage is preset to `"pre-alpha"` as this setting is appropriate for new lessons initialised using the template. | ||
|
|
||
| ## Create a new repository from this template | ||
|
|
||
| To use this template to start a new lesson repository, | ||
| make sure you're logged into Github. | ||
| Visit https://github.com/carpentries/workbench-template-md/generate | ||
| and follow the instructions. | ||
| Checking the 'Include all branches' option will save some time waiting for the first website build | ||
| when your new repository is initialised. | ||
|
|
||
| If you have any questions, contact [@tobyhodges](https://github.com/tobyhodges) | ||
|
|
||
| ## Configure a new lesson | ||
|
|
||
| Follow the steps below to | ||
| complete the initial configuration of a new lesson repository built from this template: | ||
|
|
||
| 1. **Make sure GitHub Pages is activated:** | ||
| navigate to _Settings_, | ||
| select _Pages_ from the left sidebar, | ||
| and make sure that `gh-pages` is selected as the branch to build from. | ||
| If no `gh-pages` branch is available, check _Actions_ to see if the first | ||
| website build workflows are still running. | ||
| The branch should become available when those have completed. | ||
| 1. **Adjust the `config.yaml` file:** | ||
| this file contains global parameters for your lesson site. | ||
| Individual fields within the file are documented with comments (beginning with `#`) | ||
| At minimum, you should adjust all the fields marked 'FIXME': | ||
| - `title` | ||
| - `created` | ||
| - `keywords` | ||
| - `life_cycle` (the default, _pre-alpha_, is the appropriate for brand new lessons) | ||
| - `contact` | ||
| 1. **Annotate the repository** with site URL and topic tags: | ||
| navigate back to the repository landing page and | ||
| click on the gear wheel/cog icon (similar to ⚙️) | ||
| at the top-right of the _About_ box. | ||
| Check the "Use your GitHub Pages website" option, | ||
| and [add some keywords and other annotations to describe your lesson](https://cdh.carpentries.org/the-carpentries-incubator.html#topic-tags) | ||
| in the _Topics_ field. | ||
| At minimum, these should include: | ||
| - `lesson` | ||
| - the life cycle of the lesson (e.g. `pre-alpha`) | ||
| - the human language the lesson is written in (e.g. `deutsch`) | ||
| 1. **Adjust the | ||
| `CITATION.cff`, `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, and `LICENSE.md` files** | ||
| as appropriate for your project. | ||
| - `CITATION.cff`: | ||
| this file contains information that people can use to cite your lesson, | ||
| for example if they publish their own work based on it. | ||
| You should [update the CFF][cff-sandpaper-docs] now to include information about your lesson, | ||
| and remember to return to it periodicallt, keeping it updated as your | ||
| author list grows and other details become available or need to change. | ||
| The [Citation File Format home page][cff-home] gives more information about the format, | ||
| and the [`cffinit` webtool][cffinit] can be used to create new and update existing CFF files. | ||
| - `CODE_OF_CONDUCT.md`: | ||
| if you are using this template for a project outside The Carpentries, | ||
| you should adjust this file to describe | ||
| who should be contacted with Code of Conduct reports, | ||
| and how those reports will be handled. | ||
| - `CONTRIBUTING.md`: | ||
| depending on the current state and maturity of your project, | ||
| the contents of the template Contributing Guide may not be appropriate. | ||
| You should adjust the file to help guide contributors on how best | ||
| to get involved and make an impact on your lesson. | ||
| - `LICENSE.md`: | ||
| in line with the terms of the CC-BY license, | ||
| you should ensure that the copyright information | ||
| provided in the license file is accurate for your project. | ||
| 1. **Update this README with | ||
| [relevant information about your lesson](https://carpentries.github.io/lesson-development-training/collaborating-newcomers.html#readme)** | ||
| and delete this section. | ||
|
|
||
| [cff-home]: https://citation-file-format.github.io/ | ||
| [cff-sandpaper-docs]: https://carpentries.github.io/sandpaper-docs/editing.html#making-your-lesson-citable | ||
| [cffinit]: https://citation-file-format.github.io/cff-initializer-javascript/ | ||
| [workbench]: https://carpentries.github.io/sandpaper-docs/ | ||
| # AI-assisted Coding with Codeium | ||
|
|
||
| <!-- BADGES | ||
| It is customary to add "badges" to the top of your README. These might include: | ||
| * A badge for your lesson DOI. If you have published on Zenodo, the Markdown source for this badge is available in the sidebar of the relevant Zenodo entry. | ||
| * A badge indicating the status of any important workflows running on your repository, e.g. the lesson build workflow. This will help visitors quickly see the health of the current version of the repository. | ||
| --> | ||
|
|
||
|
|
||
| This interactive workshop “AI-assisted Coding with Codeium” is designed for researchers who want to optimize their coding workflow using AI tools. Whether you are new to coding or experienced, this class will guide you through practical techniques to improve your coding experience. You will learn how to configure and use AI coding assistants to generate, refactor, and improve code, automate repetitive tasks, and improve documentation. Essential topics such as debugging with AI assistance and managing ethical and security considerations in AI-powered coding environments will also be covered. | ||
|
|
||
| This hands-on session is perfect for anyone who wants to simplify their coding process, save time, and write cleaner, more efficient code. By the end, you will have the skills you need to integrate AI into your coding practice with confidence. Basic programming knowledge and experience with a code editor such as VS Code are recommended. | ||
|
|
||
| [Visit the lesson built from this repository](olgaminaeva.github.io/gen-ai-coding/). | ||
|
|
||
| ## Contributing | ||
| Please see the [CONTRIBUTING.md](CONTRIBUTING.md) for contributing guidelines and details on how to get involved with this project. | ||
|
|
||
| Also see the current list of [issues](https://github.com/olgaminaeva/gen-ai-coding/issues) | ||
| for ideas for contributing. Look for the tag . | ||
| This indicates that the issue does not require in-depth knowledge of the project and lesson infrastructure, and is a good opportunity for a new contributor to get involved. | ||
|
|
||
| The  tag indicates issues that we would particularly appreciate contributions to fix. | ||
|
|
||
| To learn more about how this lesson site is built and how you can edit the pages, see [the Introduction to The Carpentries Workbench][sandpaper-docs]. | ||
|
|
||
|
|
||
| ## Maintainer(s) | ||
| Current Maintainers of this lesson are: | ||
|
|
||
| * [Giulia Crocioni](https://github.com/gcroci2) | ||
| * [Olga Minaeva](https://github.com/olgaminaeva) | ||
|
|
||
| ### Former Maintainers | ||
|
|
||
| * [None](FIXME) | ||
|
|
||
|
|
||
| ## Citation | ||
| See [CITATION.cff](CITATION.cff) for citation information, including a list of authors. | ||
|
|
||
| ## License | ||
| Lesson content is published with a [CC-BY](LICENSE.md) license. | ||
|
|
||
|
|
||
| ## Contact | ||
| Please get in touch with [Giulia]([email protected]) or [Olga]([email protected]) with any questions about this lesson. | ||
|
|
||
| [sandpaper-docs]: https://carpentries.github.io/sandpaper-docs/ |