diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e9793bb --- /dev/null +++ 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/BeyteFlow/errlens +cd errlens +``` + +### 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! πŸš€