Skip to content

Conversation

@TrialDragon
Copy link
Member

Objective

Fixes #14884

We have launched the new contributing guide on Bevy's website, so these sources of information should be removed to avoid syncing across duplicate files and maintaining a single source of truth on contributing.

Solution

Remove the files:

  • docs/release_checklist.md.
  • docs/the_bevy_organization.md.
  • .github/contributing/engine_style_guide.md.
  • .github/contributing/example_style_guide.md.

These are replaced by:

  • https://bevyengine.org/learn/contribute/project-information/release-process/.
  • https://bevyengine.org/learn/contribute/project-information/bevy-organization/.
  • https://bevyengine.org/learn/contribute/helping-out/opening-pull-requests/#style-guide.
  • https://bevyengine.org/learn/contribute/helping-out/creating-examples/#style-guide

Make CONTRIBUTING.md re-direct to Bevy's website's Contributing Guide https://bevyengine.org/learn/contribute/introduction

Change the contributing guide link in welcome.yml workflow to link to Bevy's website's Contributing Guide https://bevyengine.org/learn/contribute/introduction

Testing

I looked at the markdown files in my repository's branch to make sure they look fine. I have not tested the welcome.yml workflow since I don't know how, without having a new contributor make a PR to my branch.

@TrialDragon TrialDragon added C-Docs An addition or correction to our documentation S-Blocked This cannot move forward until something else changes A-Meta About the project itself D-Straightforward Simple bug fixes and API improvements, docs, test and examples labels Aug 23, 2024
@alice-i-cecile alice-i-cecile added this to the 0.15 milestone Aug 23, 2024
@TrialDragon
Copy link
Member Author

TrialDragon commented Aug 23, 2024

Blocked on bevyengine/bevy-website#1614 (straight-forward), bevyengine/bevy-website#1615 (straight-forward), and bevyengine/bevy-website#1616 (trivial) so that the content is there properly before it is removed here.

Edit: Unblocked 🎉

@alice-i-cecile alice-i-cecile added S-Needs-Review Needs reviewer attention (from anyone!) to move forward and removed S-Blocked This cannot move forward until something else changes labels Aug 23, 2024
@TrialDragon TrialDragon marked this pull request as ready for review August 23, 2024 03:40
@lewiszlw lewiszlw added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Aug 23, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Aug 23, 2024
Merged via the queue into bevyengine:main with commit 9054d9d Aug 23, 2024
@TrialDragon TrialDragon deleted the trialdragon/14884_de-duplicate_contributing_information branch August 23, 2024 18:34
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 D-Straightforward Simple bug fixes and API improvements, docs, test and examples 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.

Remove duplicated CONTRIBUTING information

3 participants