Skip to content

Latest commit

 

History

History
110 lines (69 loc) · 3.76 KB

CONTRIBUTING.md

File metadata and controls

110 lines (69 loc) · 3.76 KB

Contributing to Bhagwad Gita API

We welcome your contributions to Bhagwad Gita API! By contributing to this project, you help us make it better and empower creative minds worldwide. Please take a moment to read and follow this guide to ensure a smooth contribution process.

Table of Contents

Getting Started

Before you start contributing to Bhagwad Gita API, make sure you have the necessary tools and configurations in place.

Prerequisites

  • Node.js (Installed globally)
  • Docker (Optional, for containerization)

Installation

  1. Fork the repository: Click the "Fork" button in the upper right corner of this repository's page.

  2. Clone your fork: In your terminal, use the following command to clone your forked repository:

    git clone https://github.com/your-username/Bhagwad-Gita-API.git

  3. Navigate to the project directory:

    cd Bhagwad-Gita-API

  4. Install dependencies:

    npm install

Setting Up Environment Variables

To configure SnapLine, you need to set up environment variables. We use a .env file to manage these variables. Follow these steps:

  1. Create a .env file: In the project root directory, create a file named .env.

  2. Add environment variables: Add the required environment variables to your .env file. Refer to the README for a list of environment variables and their descriptions.

  3. Add comments (important!): When adding environment variables, it's crucial to provide comments explaining their purpose and any specific configuration details. This helps other developers understand their usage.

Here's an example of how to format your .env file:

# MongoDB connection URL
MONGODB_URI="contact me to get database url or creating replica for testing"

Development Guidelines

Code Structure

  • Follow best practices for TypeScript and React development.
  • Maintain a clean and organized code structure.
  • Use meaningful variable and function names.

Adding Environment Variables

When you add new environment variables or update existing ones, make sure to:

  • Include comments explaining their purpose and any configuration details.

Code Comments

  • Add comments to your code, especially for complex logic or non-obvious functionality.
  • Document your functions and components with comments explaining their purpose, inputs, and outputs.

Submitting Changes

  1. Create a new branch: Before making changes, create a new branch with a descriptive name:

    git checkout -b feature-name

  2. Make your changes: Write your code and commit your changes frequently with clear and concise commit messages.

  3. Push your changes: Push your branch to your fork on GitHub:

    git push origin feature-name

  4. Create a pull request: Go to the main repository on GitHub and create a pull request from your forked branch. Describe your changes and provide context.

  5. Review and collaboration: Participate in the review process, respond to feedback, and collaborate with other contributors to ensure your changes align with project goals.

Contact

Have questions or need assistance? Reach out to us: