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

Document ideal package structure #28

Open
xinnanyemm opened this issue Dec 8, 2022 · 2 comments
Open

Document ideal package structure #28

xinnanyemm opened this issue Dec 8, 2022 · 2 comments

Comments

@xinnanyemm
Copy link

xinnanyemm commented Dec 8, 2022

Create a document that covers the general shape of an ideal package within our ecosystem, using the module template as an example.

@mcmire mcmire changed the title Reference: Package overview Document ideal package structure Aug 18, 2023
@xinnanyemm
Copy link
Author

@Gudahtt
Copy link
Member

Gudahtt commented Sep 28, 2023

Examples of topics:

  • Where do we put source files? What about build files? (src and dist)
  • Where do tests go? What about "test helpers"?
  • How are types included in the package?
  • Where should Bash scrips go (used for dev tools or CI)
  • Contributor documentation
  • What should the README include?
  • Package.json fields/metadata
  • Where do we put the license?
    • Maybe also good to include brief licensing recommendations and process for getting approval from legal team
  • Where does generated API documentation go?
  • Configuration files
  • How do we keep packages in-sync with the module template?
    • Maybe reference the @metamask/template-sync tool

No need to cover every single topic, these are just ideas

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

No branches or pull requests

5 participants