From a2765c619f9d5386b779883e55177f27aff300a7 Mon Sep 17 00:00:00 2001 From: 2400032703kotinijeswanth <2400032703@kluniversity.in> Date: Fri, 7 Nov 2025 18:53:31 +0530 Subject: [PATCH] docs(contrib): add CONTRIBUTING.md with contribution guidelines --- CONTRIBUTING.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0803d81 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,44 @@ +# Contributing to Y24OpenSourceEngineering + +Thank you for your interest in contributing! This document explains how to get started. + +## Code of Conduct +Be respectful and constructive when interacting with others. + +## How to Contribute +1. **Fork** this repository and **clone** your fork. +2. **Create a new branch** for your contribution. +3. Make your changes or additions. +4. Test your changes (if applicable). +5. **Commit** using clear, descriptive messages. +6. **Push** to your fork. +7. **Open a Pull Request (PR)** to the `main` branch of this repo. + +## Branch naming convention +Use descriptive names, such as: +- `fix/issue-description` +- `feat/new-feature` +- `docs/update-readme` + +## Commit message style +Use short, imperative messages: + + +## Reporting bugs +If you find an issue: +- Check the existing [Issues](../../issues) +- Open a new issue with a clear title and description. + +## Suggesting features +Create an issue describing: +- The problem it solves +- Proposed approach +- Possible alternatives + +## Submitting a Pull Request +Before submitting: +- Ensure your code is properly formatted. +- Make sure it builds/tests successfully. +- Reference related issue numbers in the PR description. + +Thank you for helping improve **Y24OpenSourceEngineering**! ❤️