PairDrop/CONTRIBUTING.md
2023-01-19 19:07:43 +01:00

1.7 KiB

Priorities

  • PairDrop should be extremely simple, clean, and easy to use.
  • The main user flow should never be obstructed!
  • New features must be tested thoroughly before we are able to merge them.
  • Stability always comes first!

Agenda

PairDrop is a study in radical simplicity. The user interface is insanely simple. Features are chosen very carefully because complexity grows quadratically since every feature potentially interferes with each other feature. We focus very narrowly on a single use case: instant file transfer. We are not trying to optimize for some edge-cases. We are optimizing the user flow of the average users. Don't be sad if we decline your feature request for the sake of simplicity.

If you want to learn more about simplicity you can read Insanely Simple: The Obsession that Drives Apple's Success or Thinking, Fast and Slow.

Contributing guidelines

Make sure to follow these guidelines before opening an issue or a pull request:

  • Before opening an issue of a pull request, please check if the issue or the pull request already exists.
  • Pull requests for packages updates are not allowed since there is Dependabot that checks them automatically.
  • If you don't know how to contribute, also if you don't know JavaScript or Node.js, you can still share your awesome ideas with a new issue (feature request) and check the whole project for misspellings, too.