Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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**! ❤️