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

[Misc] Update README.md to include relevant links #4573

Merged
merged 1 commit into from
Oct 4, 2024

Conversation

torranx
Copy link
Collaborator

@torranx torranx commented Oct 4, 2024

What are the changes the user will see?

  • game-wise none
  • gh-wise -> updated readme

Why am I making these changes?

  • files under docs directory most esp comments.md, which is relevant for devs/contributors in documenting their code, are not well-known

What are the changes from a developer perspective?

  • added a new section ### Documentation which links the project's auto-generated docs, enemy-ai.md, and comments.md
  • linked eslint.config.js in #### Linting

Screenshots/Videos

How to test the changes?

Checklist

  • I'm using beta as my base branch
  • There is no overlap with another PR?
  • The PR is self-contained and cannot be split into smaller PRs?
  • Have I provided a clear explanation of the changes?
  • Have I considered writing automated tests for the issue?
  • If I have text, did I make it translatable and add a key in the English locale file(s)?
  • Have I tested the changes (manually)?
    • Are all unit tests still passing? (npm run test)
  • Are the changes visual?
    • Have I provided screenshots/videos of the changes?

@torranx torranx requested a review from a team as a code owner October 4, 2024 07:48
@torranx torranx added Lead Dev Review Lead Dev Review is required Miscellaneous Changes that don't fit under any other label labels Oct 4, 2024
@Tempo-anon Tempo-anon merged commit a5db2e1 into pagefaultgames:beta Oct 4, 2024
14 checks passed
@torranx torranx deleted the dev/update-readme branch October 4, 2024 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Lead Dev Review Lead Dev Review is required Miscellaneous Changes that don't fit under any other label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants