Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up install/, issues/, and flirtsch/ folders in repo #3461

Merged
merged 9 commits into from Nov 22, 2021

Conversation

joshuacwnewton
Copy link
Member

@joshuacwnewton joshuacwnewton commented Jul 14, 2021

Checklist

GitHub

PR contents

Description

I few months ago, I was inspired by this ARCHITECTURE.md article to write a "Project Overview" page for the SCT Wiki. My goal was to make SCT's project architecture easier to understand, so that new contributors wouldn't feel lost or intimidated, and could find what they need in the codebase. Writing that page made me realize that there are some small ways we can clean up the repo so that it will be slightly easier to navigate for new contributors:

Linked issues

Closes #3559.

These scripts were developed 6 years ago to help a user on the
SourceForge help forum. They are out of date, and unlikely to be
of use to anyone presently.
Most of the scripts in this folder are outdated/unused/broken. This
used to be a module needed for SCT installation/updating, but is
no longer a part of the core SCT package, and is mostly a relic of
a previous era of SCT development. Therefore, it should be relegated
to the 'dev/' folder to avoid confusing new contributors.

NB: The 'dev/' folder itself is in need of cleanup, but that would be
a larger undertaking.
@joshuacwnewton joshuacwnewton requested a review from a team July 14, 2021 16:08
@joshuacwnewton joshuacwnewton self-assigned this Jul 14, 2021
@joshuacwnewton
Copy link
Member Author

joshuacwnewton commented Jul 14, 2021

Regarding 24bcc1d, if we wanted to be really thorough about these issues/ scripts, we could go back to the specific SourceForge thread and upload them directly there, but my gut tells me this is unnecessary.

@joshuacwnewton joshuacwnewton added the installation category: install_sct or pip/setup.py label Jul 14, 2021
flirtsch/README.md Outdated Show resolved Hide resolved
@joshuacwnewton joshuacwnewton changed the title Clean up install/ and issues/ folders in repo Clean up install/, issues/, and flirtsch/ folders in repo Nov 22, 2021
@joshuacwnewton joshuacwnewton merged commit 4d76b06 into master Nov 22, 2021
@joshuacwnewton joshuacwnewton deleted the jn/repo-clean-up branch November 22, 2021 19:38
joshuacwnewton added a commit that referenced this pull request Jan 18, 2022
* `issues/`: Delete outdated user scripts
These scripts were developed 6 years ago to help a user on the
SourceForge help forum. They are out of date, and unlikely to be
of use to anyone presently.

* 'install/': Move inside `dev/` folder
Most of the scripts in this folder are outdated/unused/broken. This
used to be a module needed for SCT installation/updating, but is
no longer a part of the core SCT package, and is mostly a relic of
a previous era of SCT development. Therefore, it should be relegated
to the 'dev/' folder to avoid confusing new contributors.
NB: The 'dev/' folder itself is in need of cleanup, but that would be
a larger undertaking.

* Delete `flirtsch/` folder
As per @jcohenadad's suggestion, as the link in Tanguy's paper can't be changed, and the benefits outweigh the cons.
@joshuacwnewton joshuacwnewton added this to the 5.5 milestone Jan 26, 2022
@joshuacwnewton joshuacwnewton added git/github category: meta-discussion about project management and development practices and removed installation category: install_sct or pip/setup.py labels Jan 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
git/github category: meta-discussion about project management and development practices maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove flirtsch/ after link has been changed in NeuroImage paper
4 participants