Skip to content

docs: update links to contributing guide#2716

Merged
ChristianMurphy merged 2 commits into
uPortal-Project:masterfrom
ChristianMurphy:docs/correct-links-to-contributing
Nov 2, 2023
Merged

docs: update links to contributing guide#2716
ChristianMurphy merged 2 commits into
uPortal-Project:masterfrom
ChristianMurphy:docs/correct-links-to-contributing

Conversation

@ChristianMurphy

@ChristianMurphy ChristianMurphy commented Nov 2, 2023

Copy link
Copy Markdown
Member
Checklist
  • the individual contributor license agreement is signed
  • commit message follows commit guidelines
  • tests are included
  • documentation is changed or added
  • new security keys and comments added to security.properties
  • new general keys and comments added to portal.properties
  • any changes that impact configuration or the database DDL added to CHANGES.md
  • message properties have been updated with new phrases
  • view conforms with WCAG 2.0 AA
Description of change

This corrects the link to the contributing guide, which is now in the .github folder

cbeach47
cbeach47 reviewed Nov 2, 2023
View reviewed changes

@cbeach47 cbeach47 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Seems odd that it's in the .github folder. I would think it should be under the docs folder.

Do you see a reason it should stay in the .github folder?

Also, not specifically needed, but the Jasig content path segment could be switched to uPortal-Project.

@ChristianMurphy

ChristianMurphy commented Nov 2, 2023

Copy link
Copy Markdown
Member Author

Do you see a reason it should stay in the .github folder?

At the time root and .github were the two magic folders.
It looks like there are currently 3 magic folders
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file

GitHub will use and display default files for any repository owned by the account that does not have its own file of that type in any of the following places:
The root of the repository
The .github folder
The docs folder

Also, not specifically needed, but the Jasig content path segment could be switched to uPortal-Project.

Good point, I'll update this

@ChristianMurphy ChristianMurphy force-pushed the docs/correct-links-to-contributing branch from b175561 to c099c9b Compare November 2, 2023 20:34
cbeach47
cbeach47 approved these changes Nov 2, 2023
View reviewed changes

@cbeach47 cbeach47 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM! 🎉

@ChristianMurphy ChristianMurphy merged commit 2ababaa into uPortal-Project:master Nov 2, 2023
@ChristianMurphy ChristianMurphy deleted the docs/correct-links-to-contributing branch November 2, 2023 20:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cbeach47 cbeach47 cbeach47 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ChristianMurphy @cbeach47