From c11ddfc6b68d9ee8f4c10227ab440f4cf1757dc1 Mon Sep 17 00:00:00 2001 From: tuankaka-dev Date: Tue, 28 Apr 2026 21:10:03 +0700 Subject: [PATCH] docs: add CONTRIBUTING.md guidelines --- CONTRIBUTING.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..43a3b57 --- /dev/null +++ b/CONTRIBUTING.md @@ -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! 🚀