Contribution guidelines

[dhruvkb]

pls welcomes issues and PRs in the following categories

• bug fixes
  There should not be any bugs in a software that aims to replace ls in day to day use. Issues finding bugs (with reproduction please!) and PRs fixing them are most welcome.

• features
  pls needs to meet and exceed the expectations of pro users. Issues describing new groundbreaking features and PRs adding them are most welcome.

• code quality
  Idiomatic and readable Python is at the core of pls. Issues finding ways to better express the code and PRs improving code quality and readability are most welcome.

• documentation
  Good documentation for pls's vast feature set and customisability is essential. Issues finding incorrect or improvable docs and PRs improving them are most welcome.

• performance
  Using an interpreted language like Python comes at a cost: performance. Issues finding critical performance bottlenecks and PRs fixing them are most welcome.