Add unwritten standards from Farama Handbook, fix typos

[elliottower]

This PR adds a couple of unwritten standards taken from the Farama Handbook, and fixes some wording/typos.

Additions (general standards):

• User Experience standards:
  • Include polished rendering for all environments. Rendering should be inviting and appealing, especially for newcomers to RL.
  • Include descriptive warning and error messages When something goes wrong, it should be as easy as possible to identify the problem. Python f-Strings and assert statements are encouraged to catch common errors.
• Organization standards:
  • Limit projects to a single purpose. Ideally, standard APIs, utilities, environments and datasets should be split into separate repositories. This makes maintenance more manageable and simplifies user experience.
  • External dependencies should be limited, and include only well-maintained projects. If an external dependency stops being maintained, benchmarks can no longer be maintained long term. For example, PyBullet is no longer maintained, and MuJoCo-py bindings should be updated to DeepMind's MuJoCo bindings.

Additions (Farama standards):

• Development Practices standards:
  • Limit commits and PR's to a single purpose. This makes the reviewing process significantly easier and prevents errors from slipping into the codebase.
  • Avoid committing to master. Instead, develop locally in feature branches and use PR's for review. This mitigates merge conflicts and allows multiple developers to work simultaneously without issues. Exceptions can be made for small bugfixes, but it is best to use separate branches or patches.
  • Verify and sign commits with GPG or SSH keys. This ensures commits are from trusted sources, and prevents potential attacks through spoofed identity.

[elliottower]

@mgoulao added quotes to all the lines just so it matches. The last one includes “ in the line so I wasn’t sure if the double quotes would be a problem so I wrapped with single quotes, maybe there’s a way to do an escape string or something to avoid it? Not sure what best practice is stylistically but I think this should work functionally now.

[mgoulao]

@elliottower can I merge?

[elliottower]

Yep it’s good on my end On Tue, Apr 11, 2023 at 2:33 PM Manuel Goulão @.***> wrote:

@elliottower https://github.com/elliottower can I merge?

— Reply to this email directly, view it on GitHub https://github.com/Farama-Foundation/farama.org/pull/74#issuecomment-1503891593, or unsubscribe https://github.com/notifications/unsubscribe-auth/AHVPVAZKPFWOIJYJ75EDEVDXAWPWJANCNFSM6AAAAAAWULOWQ4 . You are receiving this because you were mentioned.Message ID: @.***>

[elliottower]

Thanks

On Tue, Apr 11, 2023 at 2:58 PM Manuel Goulão @.***> wrote:

Merged #74 https://github.com/Farama-Foundation/farama.org/pull/74 into main.

— Reply to this email directly, view it on GitHub https://github.com/Farama-Foundation/farama.org/pull/74#event-8977209176, or unsubscribe https://github.com/notifications/unsubscribe-auth/AHVPVA7OJONKPJME3AFPMC3XAWSVHANCNFSM6AAAAAAWULOWQ4 . You are receiving this because you were mentioned.Message ID: @.***>