Update GitHub-related Documentation #61
Merged
Conversation
This file contains hidden or 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
Why these changes are being introduced: With the updates to user permissions/privileges/roles in our GitHub Organization, it was time to update our developer documentation to reflect these changes. How this addresses that need: * Update the GitHub documentation, including the additional information about owners versus members and repository roles * Fix other slightly-outdated information in other files Side effects of this change: None.
cabutlermit
force-pushed
the
github-documentation-updates
branch
from
0b40fc0 to
efa5a62
Compare
Why these changes are being introduced: The previous push to GitHub failed tests because of very outdated versions in the workflows. How this addresses that need: * Update the setup-python action to v4 (from v1) in the workflows * Update the python version to 3.12 (from 3.7) in the workflows * Update the python version to 3.12 in the Pipfile and update Pipfile.lock Side effects of this change: I have no idea yet!
cabutlermit
force-pushed
the
github-documentation-updates
branch
from
efa5a62 to
20d2b1c
Compare
JPrevost
requested changes
Jun 13, 2025
|
|
||
| We use [Code Climate](https://codeclimate.com/)'s GitHub integration to monitor | ||
| for code smells. Code Climate is free for open source repositories. | ||
| We use [Code Climate](https://codeclimate.com/)'s GitHub integration to monitor for code smells. Code Climate is free for open source repositories. |
There was a problem hiding this comment.
I don't think this is a broad truth in our org anymore and only EngX seems to be using it. It's also gotten really weird in the past few weeks as they are rolling out a replacement product.
There was a problem hiding this comment.
I'll leave this for another commit by you or someone else.
| repos may still use `master` and should be migrated. GitHub now provides an | ||
| easy way to do this in the web UI. In the repo's settings, you can | ||
| change the name of the default branch. | ||
| While all new repos will be created with `main` as the default branch, older repos may still use `master` and should be migrated. GitHub now provides an easy way to do this in the web UI. In the repo's settings, you can change the name of the default branch. |
There was a problem hiding this comment.
older repos may still use `master` and should be migrated if possible
There was a problem hiding this comment.
I'll leave this for another commit by you or someone else.
|
|
||
| The DSpace@MIT codebase is hosted on Atmire's GitLab organization. In order to add or modify tracking code, you will | ||
| need a GitLab account. As of June 2023, the Digital Library Systems Manager is our point of contact with Atmire. | ||
| The DSpace@MIT codebase is hosted on Atmire's GitLab organization. In order to add or modify tracking code, you will need a GitLab account. As of June 2023, the Digital Library Systems Manager is our point of contact with Atmire. |
There was a problem hiding this comment.
I'd mention the position is part of Enterprise Systems as I'd wager people won't know that title. Also, I believe Carl's title is currently Digital Repository Services Engineer
There was a problem hiding this comment.
I'm going to leave this for another commit by you or someone else.
These are minor changes in response to the code review for this PR>
JPrevost
approved these changes
Jun 13, 2025
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.
Why these changes are being introduced
With the updates to user permissions/privileges/roles in our GitHub Organization, it was time to update our developer documentation to reflect these changes.
How this addresses that need
Side effects of this change
None.