From 659c222d94470ac53f5d7157295343d3081e81cd Mon Sep 17 00:00:00 2001 From: sidharth-vijayan Date: Thu, 26 Mar 2026 20:21:08 +0530 Subject: [PATCH 1/3] Added CONTRIBUTING.md File #65 --- CONTRIBUTING.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e69de29 From ddbb9fce314458945c4a8ca856fd695900294f40 Mon Sep 17 00:00:00 2001 From: Sidharth Vijayan Date: Thu, 26 Mar 2026 20:23:50 +0530 Subject: [PATCH 2/3] Added CONTRIBUTING.md File #65 Added a comprehensive contributing guide to assist new contributors with the process and best practices. --- CONTRIBUTING.md | 150 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 150 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e69de29..1060b42 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -0,0 +1,150 @@ +# Contributing Guide + +Thank you for your interest in contributing to this project! 🎉 +We welcome contributions from everyone—whether you're fixing bugs, improving documentation, or adding new features. + +--- + +## 📌 Getting Started + +### 1. Fork the Repository + +* Click the **Fork** button at the top right of this repository. +* This creates a copy of the project under your GitHub account. + +### 2. Clone Your Fork + +```bash +git clone https://github.com/your-username/repository-name.git +cd repository-name +``` + +### 3. Set Up the Project + +Follow the project-specific setup instructions (if applicable): + +```bash +# Example +npm install +# or +pip install -r requirements.txt +``` + +--- + +## 🌱 Creating a Branch + +Always create a new branch before making changes: + +```bash +git checkout -b feature/your-feature-name +``` + +Branch naming conventions: + +* `feature/...` for new features +* `fix/...` for bug fixes +* `docs/...` for documentation updates + +--- + +## ✏️ Making Changes + +* Keep your changes small and focused. +* Write clear and meaningful commit messages. + +Example: + +```bash +git commit -m "Add user authentication feature" +``` + +--- + +## 🎯 Coding Standards + +Please follow these general guidelines: + +* Write clean and readable code +* Use meaningful variable and function names +* Follow consistent formatting +* Add comments where necessary +* Keep functions small and modular + +### Best Practices + +* Avoid code duplication +* Write reusable components/functions +* Handle errors gracefully +* Ensure your code does not break existing functionality + +--- + +## ✅ Testing + +Before submitting your changes: + +* Run existing tests (if available) +* Add new tests for new features (if applicable) +* Make sure everything works as expected + +--- + +## 📤 Submitting a Pull Request + +### 1. Push Your Changes + +```bash +git push origin feature/your-feature-name +``` + +### 2. Open a Pull Request + +* Go to your fork on GitHub +* Click **Compare & Pull Request** +* Provide a clear description of your changes + +### 3. Pull Request Guidelines + +* Describe what you changed and why +* Reference related issues (if any) +* Keep PRs focused and concise + +--- + +## 🐛 Reporting Issues + +When creating an issue, please include: + +* A clear and descriptive title +* Steps to reproduce the issue +* Expected vs actual behavior +* Screenshots (if applicable) + +--- + +## 🔄 Contribution Workflow + +1. Fork the repository +2. Clone your fork +3. Create a new branch +4. Make your changes +5. Commit and push +6. Submit a Pull Request +7. Address review feedback (if any) + +--- + +## 📜 Project-Specific Rules + +* Do not commit sensitive information (API keys, passwords, etc.) +* Keep dependencies minimal and necessary +* Update documentation when needed +* Follow existing project structure and patterns + +--- + +## 🙌 Thank You! + +Your contributions help improve this project for everyone. +We appreciate your time and effort! 🚀 From 4d934380b0d43b18a8bf8ede853c524b20103536 Mon Sep 17 00:00:00 2001 From: Naheel Muhammed Date: Thu, 26 Mar 2026 20:42:34 +0530 Subject: [PATCH 3/3] Update CONTRIBUTING.md with new guidelines --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1060b42..e9793bb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,8 +15,8 @@ We welcome contributions from everyone—whether you're fixing bugs, improving d ### 2. Clone Your Fork ```bash -git clone https://github.com/your-username/repository-name.git -cd repository-name +git clone https://github.com/BeyteFlow/errlens +cd errlens ``` ### 3. Set Up the Project