Skip to content

Latest commit

 

History

History
31 lines (17 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

31 lines (17 loc) · 1.53 KB

Contributing

Anyone is welcome to help make Leather better. We encourage contributors to let us know via Github issues what they’d like to work on. We’re happy to help get you started.

Leather aims to respond to contributor PRs within 2 working days.

Bugs

If you’ve found a bug, first check to see if an issue already exists. If so, add a comment to let us know you found it too. Otherwise, open up an issue describing in as much detail as possible how we’d be able to recreate it.

If you’re a developer, feel free to submit a Pull Request with a suggested fix.

Feature enhancements

There is a long list of features we want to add to Leather, and we’d love help working on them. Please be aware, your work will only be merged if it aligns with Leather’s product roadmap and conforms to Leather’s standards.

Coding standards

Code contributions must follow the style and patterns already employed by the project. This list of requirements is non-exhaustive. The Leather team might ask for additional changes.

  • Code must conform to our linting setup pnpm lint
  • Code formatting correctly pnpm prettier
  • Code must be typed properly with Typescript pnpm typecheck

Testing

Code should be tested thoroughly. Complex logic must be unit tested. User flows should be covered with integration tests using Playwright.

Support

The Leather team is happy to help. If you need more involved guidance for your contribution, please allow some additional time for the team to respond to your queries.