Thank you for considering contributing! We ❤️ community involvement.
- Reporting Bugs
- Suggesting Enhancements
- Development Setup
- Branching & Workflow
- Commit Message Guidelines
- Pull Request Process
- Thank You
- Search existing issues to see if the problem has already been reported.
- If not, open a new issue and include:
- A clear and descriptive title.
- Steps to reproduce the issue.
- Expected vs. actual behavior.
- Environment details (OS, Node.js version, commiter-cli version).
- Check if a similar feature request already exists.
- Open an issue with:
- A summary of the proposed feature.
- Motivation and use cases.
- Any relevant examples or mockups.
To run locally, simply execute:
<type>: <short summary>
- type:
feat,fix,docs,style,refactor,test,chore - short summary: imperative, max ~50 characters
Example:
feat: add translation error fallback prompt
If translation fails, ask user to keep the original message.
Closes #42.
- Fork the repository and clone your fork.
- Create a feature branch.
- Make your changes, ensuring linting and formatting rules pass.
- Commit using Conventional Commits.
- Push to your fork.
- Open a pull request against
odutradev/commiter-cli:mainand include:- Description of changes.
- Link to related issues.
- Screenshots or examples if applicable.
- Address any review feedback.
- Once approved and CI passes, your PR will be merged.
Thank you for helping improve Commiter CLI! Your contributions make this project better for everyone. 🎉