Skip to content

Latest commit

 

History

History
58 lines (36 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

58 lines (36 loc) · 1.67 KB

Contributing to splitBhai

Thank you for considering contributing to splitBhai! Your help is greatly appreciated. Here’s a quick guide to get you started.

Getting Started

  1. Fork the repository: Start by forking the repo and cloning your fork locally.

    git clone https://github.com/your-username/splitBhai.git
    cd splitBhai
  2. Install dependencies: Make sure you have all the required dependencies installed.

    npm install
  3. Run the app: Test if everything works by running the development server.

    npm run dev
  4. Create a new branch: Always create a new branch for your changes.

    git checkout -b feature/your-feature-name

Making Contributions

  • New features: Please open an issue before working on any significant new features to discuss the changes.

  • Code style: Follow the existing code structure and conventions.

  • Commit messages: Write clear and concise commit messages. Use present tense and keep it under 50 characters.

    Example: Add user authentication with JWT

Submitting Your Changes

  1. Push your changes:

    git push origin feature/your-feature-name
  2. Open a pull request: Go to your fork on GitHub and open a pull request to the main repo. Include a detailed description of your changes.

Developer Documentation

For developers interested in learning more about splitBhai, visit the project documentation: splitBhai Developer Docs

Code of Conduct

Be respectful and inclusive. We aim to foster a welcoming environment for everyone.

Happy coding!