Skip to content

Fix the CONTRIBUTING.rst file for the case the submodules are included#72

Merged
h-chmeruk merged 2 commits into
mainfrom
fix/CONTRIBUTING.rst_for_submodules
May 15, 2026
Merged

Fix the CONTRIBUTING.rst file for the case the submodules are included#72
h-chmeruk merged 2 commits into
mainfrom
fix/CONTRIBUTING.rst_for_submodules

Conversation

@h-chmeruk
Copy link
Copy Markdown
Contributor

Which issue(s) are closed by this pull request?

While updating sofar, I noticed that a line in CONTRIBUTING.rst should be implemented differently if the package contains submodules.

Changes proposed in this pull request:

  • Adjust the CONTRIBUTING.rst file so that, if submodules are included, the second step in setting up the project is $ git clone --recursive (...), and if they are not included just $ git clone (...)
  • Adjust the test function test_content_contributing()

@h-chmeruk h-chmeruk added this to the v0.1.0 milestone May 5, 2026
@h-chmeruk h-chmeruk added the enhancement New feature or request label May 5, 2026
@h-chmeruk h-chmeruk moved this from Backlog to Require review in Weekly Planning May 5, 2026
Copy link
Copy Markdown
Member

@ahms5 ahms5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how about a inline if statement, would that work?
sht like:

git clone {%- if add_submodules == true %}--recursive {%- endif %}https://github.com/YOUR_USERNAME/{{ project_slug }}.git

@h-chmeruk h-chmeruk requested a review from ahms5 May 8, 2026 09:49
@h-chmeruk h-chmeruk merged commit 0a6553c into main May 15, 2026
11 checks passed
@github-project-automation github-project-automation Bot moved this from Require review to Done in Weekly Planning May 15, 2026
@h-chmeruk h-chmeruk deleted the fix/CONTRIBUTING.rst_for_submodules branch May 15, 2026 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants