CONTRIBUTING.md

Contributing Guidelines

First off, thanks for taking the time to contribute!

Please read through our Architecture Overview and Installation Instructions.

Getting Started

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the core team before making a change.

• Make sure you have a GitHub account.
• Submit a GitHub issue for your issue if one does not already exist.
  • A issue is not necessary for trivial changes.
• Fork the repository on GitHub.
  • Configuring a remote for a fork
  • Syncing a fork
    • git fetch upstream
    • git checkout main
    • git merge upstream/main
  • Merging an upstream repository into your fork
    • git checkout main
    • git pull upstream main
    • Commit the merge
    • git push origin main
• When working on an issue, create a new branch from main named for issue number or custom name. Name the branch issue/<issue-number> or issue/<custom-name>. For example issue/22 for fixing issue #22.
• Make your changes.
  • Follow the Style Guides.
  • Avoid platform-dependent code.
  • Add tests if your changes contains new, testable behavior.
  • Make the tests pass.
• Create a pull request to the repository.

Tips and tricks for using the Git

• GitHub Cheat Sheet
• git-tips

Key branches

• main is the latest, deployed version

Cloud AI Code Helpers

• https://chatgpt.com
• https://gemini.google.com
• https://claude.ai
• https://chat.reka.ai
• https://www.perplexity.ai

Style Guides

Git Commit Messages

• Include an issue number to the beginning of the first line (if applicable). Example #234 YOUR_COMMIT_NAME.
• Use the present tense ("Add feature" not "Added feature").
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
• In case changing only texts or documentations include [ci skip] to the end of the first line.
• Limit the first line to 72 characters or less.
• Reference issues and pull requests liberally after the first line.

Documentation Style Guide

All *.md files must adhere to Markdown Syntax.

JavaScript Style Guide

JavaScript Code MUST adhere to JavaScript Standard Style.

Recommended IDE:

• VS Code

  • EditorConfig

• Cursor

• Project IDX

• PhpStorm

• Eclipse

• Sublime Text

• Prefer the object spread operator ({...anotherObj}) to Object.assign()

• Inline exports with expressions whenever possible

  // Use this:
  export default class ClassName {

  }

  // Instead of:
  class ClassName {

  }
  export default ClassName