Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

44 lines (27 loc) · 2.19 KB

Contributing to Loopy

Code of Conduct

Loopy has adopted the Contributor Covenant as its Code of Conduct, and we expect project participants to adhere to it.

Please read the full text so that you can understand what actions will and will not be tolerated.

Heuristics

heuristic /ˌhjʊ(ə)ˈrɪstɪk/

A technique designed for solving a problem more quickly when classic methods are too slow, or for finding an approximate solution when classic methods fail to find any exact solution

  • Priority is the best User Experience
  • Complexity should be introduced when it’s inevitable
  • Code should be easy to reason about
  • Code should be easy to delete
  • Avoid abstracting too early
  • Avoid thinking too far in the future

How to contribute

There are many ways to contribute to the project. Code is just one possible means of contribution.

  • Feedback. Tell us what we're doing well or where we can improve.
  • Report. Create issues with bug reports so we can make Loopy even better.

Working on your first Pull Request?

There are a lot of great resources on creating a good pull request. We've included a few below, but don't be shy—we appreciate all contriibutions and are happy to help those who are willing to help us!

Preparing a Pull Request

Pull Requests are always welcome, but before working on a large change, it is best to open an issue first to discuss it with maintainers.

A good PR is small, focuses on a single feature or improvement, and clearly communicates the problem it solves. Try not to include more than one issue in a single PR. It's much easier for us to review multiple small pull requests than one that is large and unwieldy.

  1. Fork and clone the repo
  2. Run pnpm install to install dependencies and run validation
  3. Create a branch for your PR with git checkout -b pr/your-branch-name