Contributor Guidelines

The 3 Golden Rules

Contributor Guidelines can be a lot to digest—so if you only remember one thing from this guide, let it be these three golden rules.

  1. 🧹 Leave It Cleaner Than You Found It
    cleanup

    Every time you touch a piece of code, make sure you leave it in a better state than you found it. Think of the codebase as a shared workspace—tidy up as you go, and everyone will appreciate it.

  2. 🔍 Do It Right the First Time
    “I’ll do it quickly now, and fix it later.”

    no

    Let’s be honest—you’re unlikely to come back and clean it up later. Aim for quality from the start, and spare yourself (and your fellow developers) a later headache.

  3. 🤓 Take Pride in Your Work: Write Code That’s a Joy to Read and Pay Attention to the Detail
    cleanCode

    Be proud of every line you write. Craft code that’s not only functional but also a delight to read and review. Our project thrives on the passion and dedication of its contributors—your enthusiasm makes all the difference. Remember, it’s the little things—the careful touches and attention to detail—that differentiates a good software from a great software.

Best Practices

Think of our course management tool as our baby—it needs proper care to grow into a robust, well-rounded adult. Here’s how to help it flourish, especially when preparing PRs:

  1. Take Your Time
    Quality code isn’t produced in a rush. Review your work thoroughly especially when you review PRs.

  2. Use Clear Method and Variable Names
    Choose names that explain what the method does. If it sounds like a riddle, it’s time for a rename.

  3. Keep Files Short and Focused
    Each file should have a single, clear purpose. In TypeScript, try to keep files under 200 lines—let’s save the epic sagas for novels.

  4. Avoid Copy-Pasting Code
    If you’re tempted to copy code, instead abstract it into a reusable function. Reuse wisely—no one wants to chase down duplicated bugs.

  5. Keep Related Functionality Together
    Place utility functions, interfaces, etc., close to where they’re needed but ensure they’re accessible to all parts of the codebase that require them.

  6. Comment on Deviations
    Sometimes, the standard won’t quite fit. If you need to deviate, explain why with a comment. Future you (and your fellow developers) will thank you.

  7. Eliminate Dead Code Immediately
    “I might need this later” is a myth. Dead code clutters the project. Remember: Git history is your safety net if you ever need to recover something.

Important This list isn’t exhaustive. As we learn and grow, so should our guidelines. Update and refine these rules regularly—after all, improvement is a journey, not a destination.

Coding Guidelines

Next to the general golden rules and best practices, the following defines strict guidelines that should be followed throughout the codebase.

Coding Guidelines

Your read through the whole guide.

thankYou

Now, you are ready to write AWESOME Prompt Code!