Skip to content

This repo contains documentation and a list of rule sets for CodePal. A chat gpt chat bot to pull from, having to store all the files in the chat

Notifications You must be signed in to change notification settings

Devlander-Software/codepal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

Devlander Development and Deployment Standards

Welcome to the Devlander GitHub repository. This repository serves as a centralized source of best practices, configurations, and guidelines for various development topics. Each document is structured to provide targeted guidance across Devlander’s projects, making it easy for ChatGPT to reference and provide accurate answers based on these guidelines.

Repository Structure

All topic-specific documentation is stored within the topic/ directory. Each subdirectory in topic/ contains Markdown files covering various aspects of development:

  • topic/expo/: Documentation related to Expo projects, including setup, EAS CLI, configuration plugins, error handling, and OTA updates.
  • topic/fetching/: Guidance on aggregating GitHub issues and resources to streamline error handling.
  • topic/general/: General coding guidelines and best practices applicable across all projects.
  • topic/node/: Node.js-focused best practices, including validation in Express and structured error messaging.
  • topic/react/: React and React Native-specific guidelines covering components, styling, and hooks.
  • topic/typescript/: TypeScript best practices, async handling, networking recommendations, and bot configuration tips.

Each file in these directories provides in-depth explanations to help ChatGPT address specific questions accurately.

Using This Repository with ChatGPT

To enable ChatGPT to use this repository for answering queries:

  1. Share the URL of this GitHub repository with ChatGPT.
  2. Direct questions regarding specific topics, coding standards, or frameworks. ChatGPT will be able to reference relevant Markdown files in the topic/ directory for contextual answers.
  3. Each time you update this repository, ChatGPT can access the latest guidelines, ensuring responses reflect current best practices.

Key Documents and Their Topics

General Guidelines

  • Coding_Guidelines.md: Core coding standards, including clarity, performance, reliability, and error handling practices.

TypeScript and React Standards

Expo and EAS CLI

Node and Express

Advanced Debugging and Optimization

Implementation Tips and Adaptive Responses

Contributing and Updating

To contribute:

  1. Clone this repository and create a branch for your updates.
  2. Ensure each update is documented in the appropriate Markdown file within the topic/ directory.
  3. Submit a pull request, and upon merging, ChatGPT will be able to access the latest updates for referencing in answers.

By using this repository, Devlander’s development standards remain centralized, current, and accessible to ChatGPT, enabling accurate, up-to-date responses to development queries.

About

This repo contains documentation and a list of rule sets for CodePal. A chat gpt chat bot to pull from, having to store all the files in the chat

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published