From a2cb5bcfa1236cfeab08c5a21c9cba7845603830 Mon Sep 17 00:00:00 2001 From: Abhishek Kumar <113116498+abhiraj-ku@users.noreply.github.com> Date: Tue, 17 Sep 2024 22:59:26 +0530 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cc98b19 --- /dev/null +++ b/CONTRIBUTING.md @@ -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!