Skip to content

Latest commit

 

History

History
18 lines (15 loc) · 1.17 KB

contributing.md

File metadata and controls

18 lines (15 loc) · 1.17 KB

Issues / Bugs

Create a detailed issue in the Issues page.

Suggestions and Questions

Use the Discussions page.

Code Contribution

  • Consider asking if your change is wanted before starting to work on it or making a pull request.
  • Please try to keep the code clean and follow the existing formatting. Use ESLint.
  • I'm not interested in adding frameworks or large libraries unless they are really necessary; this app aims to be simple.
  • Use npm start to build the app and start auto rebuilding when a source file is changed.
  • You need a web server that serves the dist folder. You may need HTTPS with a trusted certificate if the service worker doesn't work. Check out local-web-server.
  • The server side part of the app (bpbin) is currently closed source.
  • Feel free to contact me on Discord about this. (@blueyescat)

After Finishing Development

  1. Test your changes on multiple browsers to ensure they work and don't break any existing functionality.
  2. Create a pull request.