Skip to content

Commit

Permalink
Update contributing guidlines to add developers docs link
Browse files Browse the repository at this point in the history
  • Loading branch information
abhiraj-ku committed Sep 17, 2024
1 parent 454e31f commit b180e75
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 17 deletions.
38 changes: 21 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,47 +6,51 @@ Thank you for considering contributing to splitBhai! Your help is greatly apprec

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
```
```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
```
```bash
npm install
```

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

```bash
npm run dev
```
```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
```
```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`
Example: `Add user authentication with JWT`

## Submitting Your Changes

1. **Push your changes**:

```bash
git push origin feature/your-feature-name
```
```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.

## Developer Documentation

For developers interested in learning more about splitBhai, visit the project documentation: [splitBhai Developer Docs](https://github.com/abhiraj-ku/splitBhai/blob/main/docs/Project.md)

## Code of Conduct

Be respectful and inclusive. We aim to foster a welcoming environment for everyone.
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,7 @@ Stay updated with reminders and alerts for upcoming payments, event activities,
2. **Add Expenses**: Track shared expenses and split them fairly among the group members.
3. **Settle Debts**: Either pay directly or use non-monetary options to clear up what you owe.
4. **Plan Events**: Group and tag expenses for specific events, making it easier to manage big plans like vacations or parties.

## Developer Documentation

For developers interested in learning more about splitBhai, visit the project documentation: [splitBhai Developer Docs](https://github.com/abhiraj-ku/splitBhai/blob/main/docs/Project.md)

0 comments on commit b180e75

Please sign in to comment.