Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.13 KB

File metadata and controls

56 lines (37 loc) · 1.13 KB

🤝 Contributing Guidelines

Thank you for considering contributing to Auto Commit! We welcome contributions that improve functionality, code quality, or documentation.


🧩 How to Contribute

  1. Fork the repository

  2. Create a new branch for your feature or fix

    git checkout -b feat/your-feature-name
  3. Make your changes — ensure code is clean and documented

  4. Commit with a standardized message

    npm run commit
  5. Push your branch and open a Pull Request


🧠 Commit Convention

Auto Commit follows a standardized commit message format:

<type>(scope): <short summary>

Examples:

feat(core): add auto-push feature
fix(cli): resolve path issue on Windows

Allowed types: feat, fix, docs, chore, refactor, test, style


✅ Code Style

  • Follow existing formatting and naming conventions
  • Keep PRs focused and minimal
  • Use clear, descriptive variable and function names

💬 Need Help?

Open an issue with details about your question or suggestion.