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:

  • JavaScript (ES6)
  • Node.js
  • HTML & CSS
  • Markdown
  • Command-line environment

Third, ensure you have spent time with MarkBind and familiar with the content of the user guide. 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. (Optional) Go through our onboarding bootcamp (see the Onboarding Bootcamp page)
  4. Submit PRs as per the workflow. If you encounter any problems, post in our issue tracker.
  5. (Optional) Add yourself to the contributors list! (Bug reported? PR merged? If you haven't done so already, add yourself to our list of contributors!)

We look forward to your PR. Happy coding!

Onboarding Bootcamp