Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix up list formatting and expand adoption section in contributing guide #1924

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rparrett
Copy link
Contributor

@rparrett rparrett commented Jan 8, 2025

There's some pretty funky stuff going on in this document with lists. The "Contributing Code" section in particular is written as a nested numbered list, but the second layer of nesting is not really a series of numbered steps. One of them only has one "sub step."

This PR:

  • Flattens some numbered sub-lists into sub-paragraphs.
  • Marks the fast-compiles steps as optional (I wouldn't mind deleting this step though)
  • Does some other misc tidying in the Contributing Code section
  • Expands the content in the adoption section, hopefully hitting the main points of Provide more guidance for PR-adopters in CONTRIBUTING bevy#12160 without going too crazy.

Here's a before / after for the number list formatting.

Screenshot 2025-01-28 at 1 01 30 PM Screenshot 2025-01-28 at 1 01 07 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant