Skip to content

docs: add CONTRIBUTING.md guidelines #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tuankaka-dev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add CONTRIBUTING.md guidelines #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
55 changes: 55 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Contributing to Gitzo

First off, thank you for considering contributing to **Gitzo**! It’s people like you that make the open-source community such an amazing place to learn, inspire, and create.

Following these guidelines helps us maintain the quality of the project and makes the contribution process easier for everyone.

---

## 1. How Can I Contribute?

### Reporting Bugs
If you find a bug, please check the [Issues](https://github.com/SIMARSINGHRAYAT/Gitzo/issues) page to see if it has already been reported. If not, open a new issue and include:
* **A clear title and description.**
* **Steps to reproduce the bug.**
* **Expected vs. Actual behavior.**
* **Screenshots or logs** (if applicable).

### Suggesting Enhancements
Have an idea to make Gitzo better? We’d love to hear it!
* Open an Issue and use the `enhancement` label.
* Explain why this feature would be useful and how it should work.

### Your First Code Contribution
1. **Fork** the repository to your own GitHub account.
2. **Clone** your fork to your local machine.
3. **Create a branch** for your work: `git checkout -b feature/your-feature-name` or `git checkout -b fix/your-bug-name`.
4. **Make your changes** and ensure the code follows the existing style.
5. **Commit your changes** using clear messages (see below).
6. **Push** to your fork: `git push origin your-branch-name`.
7. **Open a Pull Request (PR)** against the `main` branch of the original repository.

---

## 2. Style Guidelines

### Commit Messages
We prefer [Conventional Commits](https://www.conventionalcommits.org/). This keeps the history clean and readable:
* `feat: add a new feature`
* `fix: resolve a bug`
* `docs: update documentation`
* `style: formatting, missing semi-colons, etc.`

### Code Standards
* Keep code clean and well-commented.
* Ensure that your changes do not break existing functionality.
* Run any available tests before submitting your PR.

---

## 3. Code of Conduct
By participating in this project, you agree to maintain a respectful and inclusive environment. Please be kind to other contributors.

---

Thank you for your support! Happy coding! 🚀