outstatic icon indicating copy to clipboard operation
outstatic copied to clipboard

Contributing guidelines

Open avitorio opened this issue 3 years ago • 0 comments

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 https://github.com/avitorio/outstatic/pull/65:

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

avitorio avatar Nov 15 '22 13:11 avitorio