Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
abhiraj-ku authored Sep 17, 2024
1 parent 3a39735 commit a2cb5bc
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# 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.

```bash
git clone https://github.com/your-username/splitBhai.git
cd splitBhai
```

2. **Install dependencies**: Make sure you have all the required dependencies installed.

```bash
npm install
```

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

```bash
npm run dev
```

4. **Create a new branch**: Always create a new branch for your changes.

```bash
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**:

```bash
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.

## Code of Conduct

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

Happy coding!

0 comments on commit a2cb5bc

Please sign in to comment.