Skip to content

Update Contributor's Guide link in README.md#16592

Merged
alice-i-cecile merged 1 commit intobevyengine:mainfrom
james-j-obrien:patch-1
Dec 2, 2024
Merged

Update Contributor's Guide link in README.md#16592
alice-i-cecile merged 1 commit intobevyengine:mainfrom
james-j-obrien:patch-1

Conversation

@james-j-obrien
Copy link
Copy Markdown
Contributor

Objective

  • Fix outdated link in README.md

Perhaps the link name should be updated as well since the article is no longer labelled as "Contributor's Guide"?
Either way better to avoid making users click twice.

Copy link
Copy Markdown
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

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

We should also change the naming to match.

@james-j-obrien
Copy link
Copy Markdown
Contributor Author

The phrasing seems like it would also need to change as the title is just "Introduction".

Maybe something like:
If you'd like to help build Bevy, (check out our/you can find an) introduction here.

Most ways I try to phrase it sound clunky or vague, in CONTRIBUTING.md it's just referred to as "information on contributing".

@BenjaminBrienen
Copy link
Copy Markdown
Contributor

Approving as this is strictly an improvement, but those are good suggestions.

@alice-i-cecile alice-i-cecile added this pull request to the merge queue Dec 2, 2024
@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-Meta About the project itself S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it labels Dec 2, 2024
Merged via the queue into bevyengine:main with commit 793e2f2 Dec 2, 2024
ecoskey pushed a commit to ecoskey/bevy that referenced this pull request Dec 2, 2024
# Objective

- Fix outdated link in README.md

Perhaps the link name should be updated as well since the article is no
longer labelled as "Contributor's Guide"?
Either way better to avoid making users click twice.
ecoskey pushed a commit to ecoskey/bevy that referenced this pull request Jan 6, 2025
# Objective

- Fix outdated link in README.md

Perhaps the link name should be updated as well since the article is no
longer labelled as "Contributor's Guide"?
Either way better to avoid making users click twice.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Meta About the project itself C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants