Skip to content

Commit e96c0bb

Browse files
authored
Merge pull request #97 from UoMResearchIT/80-readme-has-some-unfinished-sections
Update incomplete sections in README
2 parents e2ed300 + 539e9b2 commit e96c0bb

1 file changed

Lines changed: 7 additions & 11 deletions

File tree

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Once you've chosen a new title, you can set the value for `lesson_title`
2525
in <_config.yml>
2626
- [ ] Add the URL to your built lesson pages to the repository description\*
2727
- [ ] [Add relevant topic tags to your lesson repository][cdh-topic-tags].
28-
- [ ] Fill in the fields marked `FIXME` in:
28+
- [x] Fill in the fields marked `FIXME` in:
2929
- this README
3030
- <_config.yml>
3131
- [ ] If you're going to be developing lesson material for the first time
@@ -46,17 +46,12 @@ the lesson URL <https://carpentries-incubator.github.io/new-lesson/>.
4646

4747
## Contributing
4848

49-
We welcome all contributions to improve the lesson! Maintainers will do their best to help you if you have any
50-
questions, concerns, or experience any difficulties along the way.
49+
We welcome all contributions to improve the lesson! Maintainers will do their best to help you if you have any questions, concerns, or experience any difficulties along the way.
5150

52-
We'd like to ask you to familiarize yourself with our [Contribution Guide](CONTRIBUTING.md) and have a look at
53-
the [more detailed guidelines][lesson-example] on proper formatting, ways to render the lesson locally, and even
51+
We'd like to ask you to familiarize yourself with our [Contribution Guide](CONTRIBUTING.md) and have a look at the [more detailed guidelines][lesson-example] on proper formatting, ways to render the lesson locally, and even
5452
how to write new episodes.
5553

56-
Please see the current list of [issues][FIXME] for ideas for contributing to this
57-
repository. For making your contribution, we use the GitHub flow, which is
58-
nicely explained in the chapter [Contributing to a Project](https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project) in Pro Git
59-
by Scott Chacon.
54+
Please see the current list of [issues][issues-list] for ideas for contributing to this repository. For making your contribution, we use the GitHub flow, which is nicely explained in the chapter [Contributing to a Project](https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project) in Pro Git by Scott Chacon.
6055
Look for the tag ![good\_first\_issue](https://img.shields.io/badge/-good%20first%20issue-gold.svg). This indicates that the maintainers will welcome a pull request fixing this issue.
6156

6257
## Maintainer(s)
@@ -68,17 +63,18 @@ Current maintainers of this lesson are
6863

6964
## Authors
7065

71-
A list of contributors to the lesson can be found in <AUTHORS>
66+
A list of contributors to this lesson can be found in the AUTHORS file.
7267

7368
## Citation
7469

75-
To cite this lesson, please consult with <CITATION>
70+
Information about citing this lesson will be made available in the CITATION file.
7671

7772
[community-lessons]: https://carpentries.org/community-lessons
7873
[cdh-topic-tags]: https://cdh.carpentries.org/the-carpentries-incubator.html#topic-tags
7974
[cdh]: https://cdh.carpentries.org
8075
[lesson-example]: https://carpentries.github.io/lesson-example
8176
[change-default-branch]: https://docs.github.com/en/github/administering-a-repository/changing-the-default-branch
77+
[issues-list]: https://github.com/UoMResearchIT/Programming-With-Python/issues
8278

8379

8480

0 commit comments

Comments
 (0)