Design & Interface Standards
← View All Standards

Engineering Standards

This is a live document. We update this document every now and then.

Handling Pull Requests

A great pull request starts with a great title and description with the reviewer’s mindset in mind.

What is not a great pull request?

A PR is not great if:

  • It’s been raised for the sake of merging code to the main or other branches.
  • It’s been raised without a reviewer.
  • It’s been raised without reviewing your own code.

What is a great pull request?

This is the type of PR that is expected from you at Skcript.

A PR is great if:

  • It has a great title that follows the conventional commit message guidelines.
  • It has a great description, along with appropriate attachments. For example, if you are fixing a bug, attach screenshots or videos.
  • It has been tested, and you are confident that it works as expected.
  • It has appropriate labels, and task IDs attached to it.
  • Your code is clean, free of linting errors, and is aligned with the main branch.

Tips on writing great PR descriptions

  • Please use Cursor or Copilot to write your PR description. They are great at this. Save time for yourself.
  • If you are writing on your own, sit down, think through, and write a concise description.

More to come.