🔥 Contributor Guidelines 🔥

[saimeunt]

About OP Scan

See README.

How to get an issue assigned

Warning

Submitted PRs without proper assignment will NOT be accepted.

At Walnut, we highly value code quality. We ensure that only the best contributors work on our code, which is why our selection process is careful and thorough.

We do not assign issues on a first-come, first-served basis. Primarily, we assign issues to contributors who have previously worked with us. However, if you are new, don’t worry—we are eager to attract new talent. We just need to get to know you and ensure you have the skills to complete the task. Below are detailed instructions on how to get an issue assigned.

It’s Your First Contribution to Walnut’s Repositories

1. Add a comment briefly introducing yourself and provide your OnlyDust profile if you want to, so we can assess if your skills match the issue.
2. Provide detailed technical instructions on how you plan to accomplish the task. Mention which functions or files you plan to edit and what code you intend to write. This will help you coming up with an appropriate solution and make sure you're not heading in the wrong direction.

You Have Already Contributed to Any of Walnut's Repositories

Please comment and provide some technical details on how you plan to accomplish the task. We may choose to assign to you even if you only comment "I'm up for it!" if nobody else is interested in the issue.

💪 Why contribute?

Asides from OnlyDust rewards, contributors providing quality PRs will be considered for interviewing with the Walnut team for an extended collaboration and/or job offer.

💬 Contributor's chat

Join us on Telegram here. Do not hesitate to ask any question, we will do our best to answer in the best way we can.

⌨️ Coding conventions

The project is already pre-configured with Eslint, TypeScript, and Prettier.

Check for any linting issues:

pnpm lint

Run prettier before committing:

pnpm prettier

🤗 Get updates from us

• Join the Walnut contributors chat on Telegram.
• Click "Follow" on the Walnut GitHub profile to stay updated on our upcoming projects.
• Support us with a follow on X.