Skip to content

Latest commit

 

History

History
42 lines (25 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

42 lines (25 loc) · 1.47 KB

Contributing

What can you contribute?

1. Feedback

Contributions in the form of feedback and issue is very much welcome. Might it be a suggestion, a bug report or maybe some questions that you have. It helps improving Kupo in the long run and these are probably the best kind of contributions to start with. See About Issues/Discussions below for guidelines.

Do not hesitate to upvote discussions or comments to show your interest!

2. Code

After running bun install, you can run the following to ensure tests pass:

buntest

This is also an automatic hook with each commit.

About Issues / Discussion

🐛 How To Report A Bug

Open a Bug Ticket.

💡 How To Propose An Idea

Feel free to bring it as a discussion [category: idea]. Make sure to highlight your use case so we can understand the design space and agree on a solution.

Note Ideally, follow this simple template:

  • What is your idea? Describe it in simple words. Provide a use case.
  • Why is it a good idea?
  • What is the current alternative and why is it not good enough?

❓ How To Ask a Question

Create a Q&A Discussion

Warning Make sure to mark your question as Answered once resolved!