avitorio/outstatic

Contributing guidelines

avitorio opened this issue · 0 comments

avitorio commented

This issue should cover the creation of contributing guidelines for the project, for both development and documentation.

Future Contributing guidelines

  • A section for contributing to docs.
  • A section for contributing to the blog example.
    • A section for website (outstatic.com) updates.
    • Specify how to test, lint, type check.

Already completed by #65:

  • Have a canary branch to merge all the pre-release updates.
  • Create a guide on how to run the monorepo locally with:
    • A section for contributing to the library.
    • Reminder: when saving or updating collections or documents, users should point to a different branch from the PR branch.