Skip to content
This repository has been archived by the owner on Oct 22, 2024. It is now read-only.

Latest commit

 

History

History
36 lines (25 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

36 lines (25 loc) · 1.81 KB

How to contribute

Reporting bugs

If you find a bug, follow the steps below to report it.

  1. Ensure the bug was not already reported by searching the issue tracker.
  2. Report the bug by opening a new issue. Include a minimal reproducible example to help us reproduce the bug.

Submitting fixes or improvements

If you have a fix, addition, or other improvement, follow the steps below to submit it.

  1. Fork the repository and create a new branch for your fix.
  2. Commit your changes and push them to your fork.
  3. Make sure the code style is consistent with already existing code.
  4. Submit a pull request explaining the problem, what changed, and how it fixes the problem.

Adding an app

If you want to add an example app for a new language, framework, or runtime, follow the steps below to submit it.

  1. Fork the repository and create a new branch for your app.
  2. Create a minimal app that demonstrates setting up the language, framework, or runtime. The app should include the following.
    • A Spacefile
    • A README.md file that describes the app and what it's build with, along with any other information relating to using your chosen language, framework, or runtime
    • A short Discovery.md file that does approximately the same thing as the README.md file
    • A .gitignore file relevant to your chosen language, framework, or runtime
    • The app should utilize Deta Base and preferably Deta Drive as well
    • Any other files that are necessary to set up and run the app
  3. Add the app to the app list in the README.md file.
  4. Open a pull request explaining what the app uses.

Thanks

Thanks for reading this guide and contributing to our community! People like you make open-source awesome. ❤️