Skip to content

[GitHub Config] Minor updates to Contribution docs & issue/PR templates#3151

Merged
tdonohue merged 2 commits intoDSpace:mainfrom
tdonohue:update_contributing
Jun 27, 2024
Merged

[GitHub Config] Minor updates to Contribution docs & issue/PR templates#3151
tdonohue merged 2 commits intoDSpace:mainfrom
tdonohue:update_contributing

Conversation

@tdonohue
Copy link
Copy Markdown
Member

@tdonohue tdonohue commented Jun 27, 2024

Description

This PR adds minor changes to our contribution docs & PR template:

  • Adds a requirement to align with Accessibility guidelines
  • Adds a requirement to use i18n keys
  • Adds a requirement to provide details on how to test PRs. (I've noticed that some developers do this better than others. It really is a requirement as we don't have a large pool of reviewers at this time)

These requirements are being MOVED from https://wiki.lyrasis.org/display/DSPACE/Code+Contribution+Guidelines#CodeContributionGuidelines-ContributionChecklist The goal is to minimize duplication, and move this checklist entirely to GitHub

This PR also makes minor changes to issue templates. Namely, it changes bold text into headers to make these issues a bit more readable. (Sections in the issue ticket are better delineated via headers)

This PR just documents these minor changes to GitHub configs/docs. There are no code changes to DSpace.

Related to backend PR DSpace/DSpace#9672

tdonohue added 2 commits June 27, 2024 14:36
…t that PRs need details on how to test them. Add requirement for accessibility & i18n.
@tdonohue tdonohue added this to the 9.0 milestone Jun 27, 2024
@tdonohue
Copy link
Copy Markdown
Member Author

Merging immediately as this involved no code changes & only minor updates to our templates/docs. (Pulling some content over from https://wiki.lyrasis.org/display/DSPACE/Code+Contribution+Guidelines#CodeContributionGuidelines-ContributionChecklist) These can always be updated later as necessary.

@tdonohue tdonohue merged commit 77081e8 into DSpace:main Jun 27, 2024
@tdonohue tdonohue deleted the update_contributing branch June 27, 2024 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

No open projects
Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

1 participant