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

Add README.md to all modules in SpacetimeDB/modules describing their usage #1974

Open
bfops opened this issue Nov 8, 2024 · 0 comments
Open

Comments

@bfops
Copy link
Collaborator

bfops commented Nov 8, 2024

In response to #432 .

Now that our code is public, it's important for outside readers to be able to understand "what is this module for?" In the case above, it seems pretty obvious that the module in question is used for testing, but many of the other modules are less obvious:

  • spacetimedb-quickstart is named very similarly to quickstart-chat, but the two are unrelated.
  • The sdk-test* modules should describe what tests call them and what SpacetimeDB features they verify.

Also, rust-wasm-test doesn't describe in enough detail what tests use the module or what it verifies.

A simple README.md in each subdir should include:

  • Whether the module is a test or an example.
  • For examples, how to run it, and a link to the document describing it, if any.
  • For tests, which test invokes it, and what that test is intended to verify.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant