Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (32 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

40 lines (32 loc) · 1.5 KB

Contributing properly.

Howdy! Thanks for having your intererst to help us improve this app. Here's what you need to follow on how to contribute PROPERLY.

General Requirements

  • You must know how to code.
  • Understand what you're writing.
  • Understand our code first before you contribute.
  • Be thoughtful and carefulwhen you're writing code.

Use of AI/LLMs.

You are allowed to use AI/LLM. BUT:

  • You must know how to code first.
    • Do not blindly copy and paste code from the LLM.
    • You are responsible for reviewing, testing and verifing everything.
  • Do not attempt to make the LLM to write malware code.

Low quality, unverified and non-tested code will be rejected and you will be blocked from doing issues/pull requests from this organization. We do not support people like you. Go improve at coding.

What is allowed and safe to contribute.

  • Bugfixes of the frontend or backend.
  • Fixing the code to be optimized and perform better.
  • Code refactor.
  • Feature enhancements

What is NOT allowed.

  • Malware injection to the code.
  • Unsafe or reckless code.
  • Obfuscated of hidden functions
  • Contributing without you understand what works.

This will lead to you getting blocked from doing issues/pull requests from this organization. We do not support people like you.

Code standards.

  • Clean, readable and maintainable code.
  • Following the structure of the code we've made.
  • Summarize Pull requests while being verbose about every commit.
  • Testing your code before submitting.