Skip to content

Conversation

@CameronCarlyon
Copy link

@CameronCarlyon CameronCarlyon commented Sep 16, 2025

Fixes #10337

Summary of Changes

  • Updated file name from Contributing.md to CONTRIBUTING.md and Resources.md to RESOURCES.md, in-line with FlyByWire naming conventions.

  • Consolidated general development documentation into to .github folder.

  • Updated CONTRIBUTING.md document to more thoroughly include references to the A380X, with minor tweaks to sentence structure throughout document to enhance readability.

  • Updated README.md to ensure correct hyperlink attributes.

  • Included change in CHANGELOG.md (not sure if this is necessary given the scope of the changes, feel free to remove)

Screenshots (if necessary)

References

Additional context

Additional hyperlink references may need to be updated by an admin, such as these notices:

image

Discord username (if different from GitHub):
YouBaconMeCrazy

Testing instructions

Links may be tested in the README.md file by clicking through and ensuring there is not a NoPage error.

How to download the PR for QA

Every new commit to this PR will cause new A32NX and A380X artifacts to be created, built, and uploaded.

  1. Make sure you are signed in to GitHub
  2. Click on the Checks tab on the PR
  3. On the left side, find and click on the PR Build tab
  4. Click on either flybywire-aircraft-a320-neo, flybywire-aircraft-a380-842 (4K) or flybywire-aircraft-a380-842 (8K) download link at the bottom of the page

- Updated file name from Contributing.md to CONTRIBUTING.md, in-line with FlyByWire naming conventions.

- Updated document to more thoroughly include references to the A380X, closing issue flybywiresim#10337.

- Minor tweaks to sentence structure throughout document to enhance readability.
@github-project-automation github-project-automation bot moved this to 🟡 Code Review: Ready for Review in Quality Assurance Sep 16, 2025
@CameronCarlyon CameronCarlyon changed the title CONTRIBUTING.md naming convention change, A380X references added and readability enhancements docs: update CONTRIBUTING.md naming, add A380X references and readability enhancements Sep 16, 2025
Changed filename to UPPERCASE format, inline with established documentation naming convention.

Reference in CONTRIBUTING.md updated.
Updated CHANGELOG to include broader documentation changes.
@CameronCarlyon CameronCarlyon changed the title docs: update CONTRIBUTING.md naming, add A380X references and readability enhancements docs: Revisions to documentation, A380X referencing, file structure consolidation, and optimised naming conventions Sep 22, 2025
@CameronCarlyon
Copy link
Author

I have pushed additional changes to address RESOURCES.md. The file has been updated to follow the established naming convention and consolidated into the .github folder with other general development documentation.

@tracernz
Copy link
Member

Unfortunately changing only the case of file names is problematic for windows so I wouldn’t recommend that. The phrasing improvements look good. The changelog is not necessary as these changes are for developers only.

@CameronCarlyon
Copy link
Author

Hey @tracernz, the RESOURCES.md and CONTRIBUTING.md files have been moved from './fbw-a32nx/docs' to './.github' thus are technically new files. This is because they are general development documentation and not applicable only to the A32NX project. Would this still be problematic with this in mind? I will revert the changelog file.

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

Labels

None yet

Projects

Status: 🟡 Code Review: Ready for Review

Development

Successfully merging this pull request may close these issues.

Contributing.md omits A380X information in some areas

3 participants