-
Notifications
You must be signed in to change notification settings - Fork 23
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
feat: non-openedx repos get instructions to find tweaks #378
Conversation
8e47fb9
to
f4a4239
Compare
@timmc-edx this is the end of my cookiecutter work for the moment (and was the reason I got started on it at all). |
CHANGELOG.rst
Outdated
@@ -5,6 +5,12 @@ Change Log | |||
This file loosely adheres to the structure of https://keepachangelog.com/, | |||
but in reStructuredText instead of Markdown. | |||
|
|||
2023-08-07 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2023-08-07 | |
2023-08-11 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to get scriv into this... I'll fix it.
if org != "openedx": | ||
print("*" * 78) | ||
print(f"Since your repo will be in the {org} organization, you may need") | ||
print("to adjust the contents of the repo. Check with your organization.") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe give examples of what might need to be changed? For example:
print("to adjust the contents of the repo. Check with your organization.") | |
print("to adjust the contents of the repo, such as licenses and email") | |
print("addresses. Check with your organization.") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea!
f4a4239
to
03d6a11
Compare
This prompts users to seek org-specific tweaks when they aren't making repos in the openedx organization. Axim would prefer not to have private wiki links in public tools, so we don't link to specific instructions like https://2u-internal.atlassian.net/wiki/spaces/ENG/pages/493453499/Repo+deltas+for+edx+GitHub+repos .
I tried to write a test for this, but could not figure out how to capture the stdout from the post hook.
Merge checklist:
Check off if complete or not applicable: