feat: non-openedx repos get instructions to find tweaks #378
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nedbat
force-pushed
the
nedbat/org-specific-instructions
branch
from
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). |
timmc-edx
reviewed
Aug 11, 2023
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.
Suggested change
| 2023-08-07 | |
| 2023-08-11 |
There was a problem hiding this comment.
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.
Maybe give examples of what might need to be changed? For example:
Suggested change
| 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.") |
nedbat
force-pushed
the
nedbat/org-specific-instructions
branch
from
f4a4239
to
03d6a11
Compare
feanil
approved these changes
Aug 11, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: