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.

Sign up for GitHub

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

Jump to bottom

Document how to make a submission #3

Open
pinobatch opened this issue Dec 6, 2023 · 0 comments
Open

Document how to make a submission #3

pinobatch opened this issue Dec 6, 2023 · 0 comments

Comments

@pinobatch
Copy link
Contributor

In the NESdev Discord server, avivace and I were brainstorming an outline of things to include in README.md:

  • How to make a new entry
    • Clone the repo
    • Fill out the most common properties in the schema for game.json
    • Create a valid slug that you're willing to commit to
    • Optionally calculate file hashes
    • Further reading: How to read a JSON schema
  • How to run tests before filing a PR
    • Make and activate a Python venv, which is required for installing packages through pip on most *n?x systems since PEP 668
    • Install the required libraries into the venv
    • Run the tests in the tests/ folder; no news is good news
    • Prevent the venv from getting checked into the repository
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pinobatch