|
1 | | -# The Carpentries Workbench Template Markdown Lesson |
| 1 | +# Style, Lint, and Format Python Code |
2 | 2 |
|
3 | | -This lesson is a template lesson that uses [The Carpentries Workbench][workbench]. |
| 3 | +This repository contains a one hour carpentries lesson about styling, linting, and formatting Python code for readability and collaboration. This lesson is for Python developers who want to write professional looking code that can be easily maintained and contributed to by others. |
4 | 4 |
|
5 | | -## Note about lesson life cycle stage |
6 | | -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. |
| 5 | +## Contributing |
7 | 6 |
|
8 | | -## Create a new repository from this template |
| 7 | +Please see the [CONTRIBUTING.md](CONTRIBUTING.md) document for contributing guidelines and details on how to get involved with this project. |
9 | 8 |
|
10 | | -To use this template to start a new lesson repository, |
11 | | -make sure you're logged into Github. |
12 | | -Visit https://github.com/carpentries/workbench-template-md/generate |
13 | | -and follow the instructions. |
14 | | -Checking the 'Include all branches' option will save some time waiting for the first website build |
15 | | -when your new repository is initialised. |
| 9 | +## Maintainer(s) |
16 | 10 |
|
17 | | -If you have any questions, contact [@tobyhodges](https://github.com/tobyhodges) |
| 11 | +Current maintainers of this lesson are: |
18 | 12 |
|
19 | | -## Configure a new lesson |
| 13 | +- [Gavin Wiggins](https://github.com/wigging) |
20 | 14 |
|
21 | | -Follow the steps below to |
22 | | -complete the initial configuration of a new lesson repository built from this template: |
| 15 | +## License |
23 | 16 |
|
24 | | -1. **Make sure GitHub Pages is activated:** |
25 | | - navigate to _Settings_, |
26 | | - select _Pages_ from the left sidebar, |
27 | | - and make sure that `gh-pages` is selected as the branch to build from. |
28 | | - If no `gh-pages` branch is available, check the _Actions_ tab to see if the first |
29 | | - website build workflows are still running. |
30 | | - If they're not running yet, you may need to manually enable them via the _Actions_ tab. |
31 | | - The branch should become available when those have completed. |
32 | | -1. **Adjust the `config.yaml` file:** |
33 | | - this file contains global parameters for your lesson site. |
34 | | - Individual fields within the file are documented with comments (beginning with `#`) |
35 | | - At minimum, you should adjust all the fields marked 'FIXME': |
36 | | - - `title` |
37 | | - - `created` |
38 | | - - `keywords` |
39 | | - - `life_cycle` (the default, _pre-alpha_, is the appropriate for brand new lessons) |
40 | | - - `contact` |
41 | | -1. **Annotate the repository** with site URL and topic tags: |
42 | | - navigate back to the repository landing page and |
43 | | - click on the gear wheel/cog icon (similar to ⚙️) |
44 | | - at the top-right of the _About_ box. |
45 | | - Check the "Use your GitHub Pages website" option, |
46 | | - and [add some keywords and other annotations to describe your lesson](https://cdh.carpentries.org/the-carpentries-incubator.html#topic-tags) |
47 | | - in the _Topics_ field. |
48 | | - At minimum, these should include: |
49 | | - - `lesson` |
50 | | - - the life cycle of the lesson (e.g. `pre-alpha`) |
51 | | - - the human language the lesson is written in (e.g. `deutsch`) |
52 | | -1. **Adjust the |
53 | | - `CITATION.cff`, `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, and `LICENSE.md` files** |
54 | | - as appropriate for your project. |
55 | | - - `CITATION.cff`: |
56 | | - this file contains information that people can use to cite your lesson, |
57 | | - for example if they publish their own work based on it. |
58 | | - You should [update the CFF][cff-sandpaper-docs] now to include information about your lesson, |
59 | | - and remember to return to it periodically, keeping it updated as your |
60 | | - author list grows and other details become available or need to change. |
61 | | - The [Citation File Format home page][cff-home] gives more information about the format, |
62 | | - and the [`cffinit` webtool][cffinit] can be used to create new and update existing CFF files. |
63 | | - - `CODE_OF_CONDUCT.md`: |
64 | | - if you are using this template for a project outside The Carpentries, |
65 | | - you should adjust this file to describe |
66 | | - who should be contacted with Code of Conduct reports, |
67 | | - and how those reports will be handled. |
68 | | - - `CONTRIBUTING.md`: |
69 | | - depending on the current state and maturity of your project, |
70 | | - the contents of the template Contributing Guide may not be appropriate. |
71 | | - You should adjust the file to help guide contributors on how best |
72 | | - to get involved and make an impact on your lesson. |
73 | | - - `LICENSE.md`: |
74 | | - in line with the terms of the CC-BY license, |
75 | | - you should ensure that the copyright information |
76 | | - provided in the license file is accurate for your project. |
77 | | -1. **Update this README with |
78 | | - [relevant information about your lesson](https://carpentries.github.io/lesson-development-training/collaborating-newcomers.html#readme)** |
79 | | - and delete this section. |
80 | | - |
81 | | -[cff-home]: https://citation-file-format.github.io/ |
82 | | -[cff-sandpaper-docs]: https://carpentries.github.io/sandpaper-docs/editing.html#making-your-lesson-citable |
83 | | -[cffinit]: https://citation-file-format.github.io/cff-initializer-javascript/ |
84 | | -[workbench]: https://carpentries.github.io/sandpaper-docs/ |
| 17 | +Lesson content is published with a [CC-BY](LICENSE.md) license. |
0 commit comments