More version-control-friendly markdown formatting

CONTRIBUTING.md

@@ -1,75 +1,45 @@
 ## Contributing
 
-[The Carpentries][cp-site] ([Software Carpentry][swc-site], [Data
-Carpentry][dc-site], and [Library Carpentry][lc-site]) are open source
-projects, and we welcome contributions of all kinds: new lessons, fixes to
-existing material, bug reports, and reviews of proposed changes are all
-welcome.
+[The Carpentries][cp-site] ([Software Carpentry][swc-site], [Data Carpentry][dc-site], and [Library Carpentry][lc-site]) are open source projects, and we welcome contributions of all kinds: new lessons, fixes to existing material, bug reports, and reviews of proposed changes are all welcome.
 
 ### Contributor Agreement
 
-By contributing, you agree that we may redistribute your work under [our
-license](LICENSE.md). In exchange, we will address your issues and/or assess
-your change proposal as promptly as we can, and help you become a member of our
-community. Everyone involved in [The Carpentries][cp-site] agrees to abide by
-our [code of conduct](CODE_OF_CONDUCT.md).
+By contributing, you agree that we may redistribute your work under [our license](LICENSE.md). In exchange, we will address your issues and/or assess your change proposal as promptly as we can, and help you become a member of our community. Everyone involved in [The Carpentries][cp-site] agrees to abide by our [code of conduct](CODE_OF_CONDUCT.md).
 
 ### Who Should Contribute?
 
 Contributions to this lesson are welcome from anyone with an interest in the project.
 
 ### How to Contribute
 
-The easiest way to get started is to file an issue to tell us about a spelling
-mistake, some awkward wording, or a factual error. This is a good way to
-introduce yourself and to meet some of our community members.
+The easiest way to get started is to file an issue to tell us about a spelling mistake, some awkward wording, or a factual error. This is a good way to introduce yourself and to meet some of our community members.
 
-1. If you have a [GitHub][github] account, or are willing to [create
-   one][github-join], but do not know how to use Git, you can report problems
-   or suggest improvements by [creating an issue][issues]. This allows us to
-   assign the item to someone and to respond to it in a threaded discussion.
+1. If you have a [GitHub][github] account, or are willing to [create one][github-join], but do not know how to use Git, you can report problems or suggest improvements by [creating an issue][issues]. This allows us to assign the item to someone and to respond to it in a threaded discussion.
 
-2. If you are comfortable with Git, and would like to add or change material,
-   you can submit a pull request (PR). Instructions for doing this are
-   [included below](#using-github).  
+2. If you are comfortable with Git, and would like to add or change material, you can submit a pull request (PR). Instructions for doing this are [included below](#using-github).  
 
-3. If you do not have a [GitHub][github] account, you can [send us comments by
-   email][contact]. However, we will be able to respond more quickly if you use
-   one of the other methods described below.
+3. If you do not have a [GitHub][github] account, you can [send us comments by email][contact]. However, we will be able to respond more quickly if you use one of the other methods described below.
 
-Note: if you want to build the website locally, please refer to [The Workbench
-documentation][template-doc].
+Note: if you want to build the website locally, please refer to [The Workbench documentation][template-doc].
 
 ### Where to Contribute
 
 1. If you wish to change this lesson, add issues and pull requests in this repository.
 
-2. If you wish to change the template used for workshop websites, please refer
-   to [The Workbench documentation][template-doc].
+2. If you wish to change the template used for workshop websites, please refer to [The Workbench documentation][template-doc].
 
 
 ### What to Contribute (General)
 
-There are many ways to contribute, from writing new exercises and improving
-existing ones to updating or filling in the documentation and submitting [bug
-reports][issues] about things that do not work, are not clear, or are missing.
-If you are looking for ideas, please see [the list of issues for this
-repository][repo], or the issues for [Data Carpentry][dc-issues], [Library
-Carpentry][lc-issues], and [Software Carpentry][swc-issues] projects.
+There are many ways to contribute, from writing new exercises and improving existing ones to updating or filling in the documentation and submitting [bug reports][issues] about things that do not work, are not clear, or are missing. If you are looking for ideas, please see [the list of issues for this repository][repo], or the issues for [Data Carpentry][dc-issues], [Library Carpentry][lc-issues], and [Software Carpentry][swc-issues] projects.
 
-Comments on issues and reviews of pull requests are just as welcome: we are
-smarter together than we are on our own. **Reviews from novices and newcomers
-are particularly valuable**: it's easy for people who have been using these
-lessons for a while to forget how impenetrable some of this material can be, so
-fresh eyes are always welcome.
+Comments on issues and reviews of pull requests are just as welcome: we are smarter together than we are on our own. **Reviews from novices and newcomers are particularly valuable**: it's easy for people who have been using these lessons for a while to forget how impenetrable some of this material can be, so fresh eyes are always welcome.
 
 ### What to Contribute (This Lesson)
 
 Any contributions are welcome, however major contributions should focus on the current development stage.
 
-If you plan to submit a pull request, please open an issue
-(or comment on an existing thread) first to ensure that effort is not duplicated
-or spent making a change that will not be accepted by the Maintainers.
+If you plan to submit a pull request, please open an issue (or comment on an existing thread) first to ensure that effort is not duplicated or spent making a change that will not be accepted by the Maintainers.
 
 #### Excercise contribution
 
@@ -85,15 +55,10 @@ If you want to contribute with an excercise content:
 
 #### Content / style guidelines
 
-- If you add an image / figure that was generated from Python code, please include this
-  code in your PR under `episodes/fig/source`.
+- If you add an image / figure that was generated from Python code, please include this code in your PR under `episodes/fig/source`.
 
 - If you add a new image or figure, verify that it displays correctly in the lesson’s dark mode. A color-inversion filter is applied [by Varnish to all images by default in dark mode](https://github.com/carpentries/varnish/issues/181), which may cause some images to appear incorrectly or become unreadable. If your image is affected, include an additional version of the same image with a `-dark` suffix in its filename.
-
-- Use the terms in the table below, when referring to Python libraries within the lesson.
-  The table gives two terms for each library: `Term for descriptive text` which should be
-  used when discussing the library in plain English / full sentences and `Term for code`
-  which should be used when referring to code (and within code).
+- Use the terms in the table below, when referring to Python libraries within the lesson. The table gives two terms for each library: `Term for descriptive text` which should be used when discussing the library in plain English / full sentences and `Term for code` which should be used when referring to code (and within code).
 
    | Python library  | Term for descriptive text | Term for code  |
    | :-------------  | :-------------            | :------------- |
@@ -115,8 +80,7 @@ If you want to contribute with an excercise content:
    rr, cc = ski.draw.rectangle(start=(357, 44), end=(740, 720))
    ```
 
-- For reading and writing images, use the [BioIO](https://github.com/bioio-devs/bioio)
-  library and avoid use of other libraries. For example:
+- For reading and writing images, use the [BioIO](https://github.com/bioio-devs/bioio) library and avoid use of other libraries. For example:
    ```python
    from bioio import BioImage
 
@@ -136,61 +100,38 @@ If you want to contribute with an excercise content:
 
 We are not looking for contributions falling outside of the defined [Learning Objectives](https://github.com/carpentries-incubator/bioimage-analysis-python/wiki/Learning-Objectives).
 
-We are also not looking for material that only runs on one
-platform. Our workshops typically contain a mixture of Windows, macOS, and
-Linux users; in order to be usable, our lessons must run equally well on all
-three.
+We are also not looking for material that only runs on one platform. Our workshops typically contain a mixture of Windows, macOS, and Linux users; in order to be usable, our lessons must run equally well on all three.
 
 ### What *Not* to Contribute (This Lesson)
 
-If you want to suggest the addition of new content, especially whole new sections or episodes,
-please open an issue to discuss this with the Maintainers first and provide the following
-information alongside a summary of the content to be added:
+If you want to suggest the addition of new content, especially whole new sections or episodes, please open an issue to discuss this with the Maintainers first and provide the following information alongside a summary of the content to be added:
 
 1. A suggested location for the new content.
-2. An estimate of how much time you estimate the new content would require in training
-   (teaching + exercises).
+2. An estimate of how much time you estimate the new content would require in training (teaching + exercises).
 3. The [learning objective(s)][cldt-lo] of this new content.
-4. (optional, but strongly preferred)
-   A suggestion of which of the currently-used learning objectives could be
-   removed from the curriculum to make space for the new content.
+4. (optional, but strongly preferred) A suggestion of which of the currently-used learning objectives could be removed from the curriculum to make space for the new content.
 
 ### Using GitHub
 
-If you choose to contribute via GitHub, you may want to look at [How to
-Contribute to an Open Source Project on GitHub][how-contribute]. In brief, we
-use [GitHub flow][github-flow] to manage changes:
+If you choose to contribute via GitHub, you may want to look at [How to Contribute to an Open Source Project on GitHub][how-contribute]. In brief, we use [GitHub flow][github-flow] to manage changes:
 
-1. Create a new branch in your desktop copy of this repository for each
-   significant change.
+1. Create a new branch in your desktop copy of this repository for each significant change.
 2. Commit the change in that branch.
 3. Push that branch to your fork of this repository on GitHub.
 4. Submit a pull request from that branch to the [upstream repository][repo].
-5. If you receive feedback, make changes on your desktop and push to your
-   branch on GitHub: the pull request will update automatically.
+5. If you receive feedback, make changes on your desktop and push to your branch on GitHub: the pull request will update automatically.
 
 NB: The published copy of the lesson is usually in the `main` branch.
 
-Each lesson has a team of maintainers who review issues and pull requests or
-encourage others to do so. The maintainers are community volunteers, and have
-final say over what gets merged into the lesson.
+Each lesson has a team of maintainers who review issues and pull requests or encourage others to do so. The maintainers are community volunteers, and have final say over what gets merged into the lesson.
 
 #### Merging Policy
 
-Pull requests made to the default branch of this repository
-(from which the lesson site is built)
-can only be merged after at least one approving review from a Maintainer.
-Any Maintainer can merge a pull request that has received at least one approval,
-but they may prefer to wait for further input from other curriculum developers before merging.
+Pull requests made to the default branch of this repository (from which the lesson site is built) can only be merged after at least one approving review from a Maintainer. Any Maintainer can merge a pull request that has received at least one approval, but they may prefer to wait for further input from other curriculum developers before merging.
 
 ### Other Resources
 
-The Carpentries is a global organisation with volunteers and learners all over
-the world. We share values of inclusivity and a passion for sharing knowledge,
-teaching and learning. There are several ways to connect with The Carpentries
-community listed at <https://carpentries.org/connect/> including via social
-media, slack, newsletters, and email lists. You can also [reach us by
-email][contact].
+The Carpentries is a global organisation with volunteers and learners all over the world. We share values of inclusivity and a passion for sharing knowledge, teaching and learning. There are several ways to connect with The Carpentries community listed at <https://carpentries.org/connect/> including via social media, slack, newsletters, and email lists. You can also [reach us by email][contact].
 
 [repo]: https://github.com/carpentries-incubator/bioimage-analysis-python
 [cldt-lo]: https://carpentries.github.io/lesson-development-training/05-objectives.html#learning-objectives

README.md

@@ -16,9 +16,7 @@ Make a suggestion or correct an error by [raising an Issue](https://github.com/c
 
 We are currently in the pre-alpha phase and are actively developing [the learning outcomes assessment](https://carpentries.github.io/lesson-development-training/fig/cldt-design-process.svg). Although all suggestions are welcome, major contributions should be focused on the current development phase.
 
-Please see the [CONTRIBUTING.md file](CONTRIBUTING.md) for contributing guidelines and details on how to get involved with 
-this project. Some specific guidelines for content / style are provided in the 
-['What to Contribute (This Lesson)' section](CONTRIBUTING.md#what-to-contribute-this-lesson).
+Please see the [CONTRIBUTING.md file](CONTRIBUTING.md) for contributing guidelines and details on how to get involved with  this project. Some specific guidelines for content / style are provided in the  ['What to Contribute (This Lesson)' section](CONTRIBUTING.md#what-to-contribute-this-lesson).
 
 ## Code of Conduct
 
@@ -34,6 +32,7 @@ The Bio-Image Analysis with Python lesson is currently being maintained by:
 The lesson is built on the original [Image Processing with Python](https://github.com/datacarpentry/image-processing) lesson content originally developed by [Mark Meysenburg](https://github.com/mmeysenburg), [Tessa Durham Brooks](https://github.com/tessalea), [Dominik Kutra](https://github.com/k-dominik), [Constantin Pape](https://github.com/constantinpape), and [Erin Becker](https://github.com/ebecker).
 
 ## Acknowledgements
+
 ![](https://avatars.githubusercontent.com/u/165169315?s=200&v=4)
 
 This lesson became a reality thanks to the many priceless contributions of the [GloBIAS expert community](https://www.globias.org/home). Learn [here](https://www.globias.org/activities/update-the-data-carpentries-bioimage-analysis-with-python-curriculum) how the whole initative started.