CONTRIBUTING.md

Contributing to Jet Admin

First off, thank you for considering contributing to Jet Admin! It's people like you that make Jet Admin such a great tool.

🌈 Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please be respectful and professional in all interactions.

🚀 Getting Started

Prerequisites

• Node.js: v20 or higher
• PostgreSQL: v14 or higher
• Git

Installation

1. Fork the repository.
2. Clone your fork: git clone https://github.com/your-username/jet-pg-admin.git
3. Install dependencies: npm install
4. Set up environment variables (copy .env.sample in apps/frontend and apps/backend).

Running Locally

Use the root scripts to start both services:

npm run start:all

🛠️ Development Workflow

1. Create a Branch: git checkout -b feature/your-feature-name
2. Make Changes: Follow our coding standards.
3. Run Tests: Ensure everything is still working.
4. Commit: Use descriptive commit messages.
5. Push: git push origin feature/your-feature-name
6. Pull Request: Open a PR against the main branch.

🎨 Coding Standards

• Tabs/Spaces: Use 2 spaces for indentation.
• Linting: Run npm run lint before committing.
• Documentation: If you add a new feature, update the relevant documentation in docs/.
• Naming: Use camelCase for variables and functions, PascalCase for React components.

🐞 Bug Reports & Feature Requests

Please use the GitHub Issue Tracker to report bugs or suggest features. Be as descriptive as possible.

---

Happy coding! 🚀