Contributing

This section contains information and help for people wanting to contribute to remoteStorage.js development.

Every bit helps, even fixing a typo is worth a pull request!

• Code overview
• Building
  • Setup
  • Development
  • Production
• Testing
  • Continous integration
• Documentation
  • How to write reStructuredText and TypeDoc
  • Automatic builds and publishing
  • How to build the docs on your machine
  • How to build the docs using ReadTheDocs’ Docker image
• GitHub workflow
  • General guidelines
  • Branch names
  • Pulling changes
  • Commit messages
  • Reviewing pull requests
  • Merging pull requests
• Release checklist
• Libary internals
  • Discovery bootstrap
  • Caching
  • Data format of the local cache