Contributing

Developer guide

Contributing

Thank you for your interest in contributing! We're glad you want to help. We welcome PRs, especially from students.

First, do take note of our code of conduct (from SE-EDU). Reporting bugs or submitting feature suggestions in our issue tracker can help too.

Second, ensure you have a basic knowledge of the following:

  • TypeScript
  • Node.js
  • HTML & CSS
  • Svelte
  • Markdown
  • Command-line environment

Third, ensure you have spent some time using CustardUI and working knowledge of MarkBind, and are familiar with their documentation. It's important to know the product well before you start contributing code.

Now, follow these steps to get started on contributing:

  1. Set up the project in your computer (see the Setting up page)
  2. Learn our workflow (see the Workflow page)
  3. Submit PRs as per the workflow. If you encounter any problems, post in our issue tracker.

We look forward to your PR. Happy coding!