From 194b1652d9973698c1ec7a81059edffaa1cc6f90 Mon Sep 17 00:00:00 2001 From: Omar <108215915+ExyoOmar@users.noreply.github.com> Date: Sat, 2 Aug 2025 08:50:37 +0000 Subject: [PATCH] docs: add CONTRIBUTING.md to guide new contributors --- CONTRIBUTING.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7a8c27c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,47 @@ +# Contributing to CommitGPT +## Hi there! 👋 +Thanks for your interest in contributing to CommitGPT — a tool to help developers write better commit messages using AI. Whether you're here to fix a bug, add a new feature, or improve documentation, you're very welcome! 🚀 + +## Getting Started +### 2. Clone your fork locally or use GitHub Codespaces. + git clone https://github.com/YOUR_USERNAME/commitgpt.git + cd commitgpt +### 3. Install dependencies + npm install +### 4. Create a new branch + git checkout -b your-branch-name +### 5. Make your changes! +### 6. Commit your changes + git commit -m "feat: short description of your feature" +### 7. Push your branch + git push origin your-branch-name +### 8. Create a Pull Request on GitHub. +_Please use a clear PR title and description, and link to any related issues._ + +## What Can You Contribute? +### Here are some great ways to help out: +Bug fixes (see Issues) +New features (CLI, AI prompts, integrations) +UX improvements (especially for the CLI or VS Code extension) +Add or improve tests +Improve documentation (like this file!) +Language/localization support +Integrations with Git clients or other IDEs + +## Code Style +### This project uses TypeScript and Prettier. +Please run formatting and follow existing code style: + npm run format +### Linting (if configured): + npm run lint + +## Questions or Help? +### If you're not sure where to start: +Look for issues labeled "good first issue" +Open a new issue with your idea or question +Or join the conversation in Discussions if available + +## License +By contributing, you agree that your contributions will be licensed under the MIT License. + +# Thanks for helping improve CommitGPT! 🎉 Your contribution makes the developer experience better for thousands of users. \ No newline at end of file