FCP-INDI / C-PAC

Configurable Pipeline for the Analysis of Connectomes
https://fcp-indi.github.io/
GNU Lesser General Public License v3.0
64 stars 40 forks source link

✏️ Move some misplaced documentation #2010

Closed shnizzedy closed 11 months ago

shnizzedy commented 11 months ago

Description

  1. This release adds a README to the .github directory, but

    If you put your README file in your repository's hidden .github, root, or docs directory, GitHub will recognize and automatically surface your README to repository visitors.

    If a repository contains more than one README file, then the file shown is chosen from locations in the following order: the .github directory, then the repository's root directory, and finally the docs directory.

https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes#about-readmes

This issue was resolved independently in two different branches that got merged into develop, moving .github/README.md to both .github/READTHIS.md and .github/README/README.md. In this PR, I merged these divergent READMEs into .github/README/README.md because that direction had fewer changes to make than the opposite direction (i.e., .github/README/README.md was more up-to-date than .github/READTHIS.md)

  1. I inadvertently put https://github.com/FCP-INDI/C-PAC/blob/1a7be7a3ccff4a6fe2cd0cc1cb6bfa770b1beb97/CHANGELOG.md?plain=1#L129 under 1.8.5 in the CHANGELOG in #1919; this PR moves that line up to 1.8.6

Checklist

Developer Certificate of Origin

Developer Certificate of Origin ``` Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. ```