Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (51 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

66 lines (51 loc) · 2.18 KB

Contributing to cma-cli

We welcome contributions to cma-cli! By participating in this project, you agree to abide by our Code of Conduct.

How to Contribute

1. Reporting Bugs

If you find a bug, please open an issue on GitHub. Before opening a new issue, please check if a similar issue already exists. When reporting a bug, please include:

  • A clear and concise description of the bug.
  • Steps to reproduce the behavior.
  • Expected behavior.
  • Screenshots or error messages if applicable.
  • Your operating system and cma-cli version.

2. Suggesting Enhancements

We love new ideas! If you have a suggestion for a new feature or an improvement, please open an issue on GitHub. Describe your idea in detail and explain why you think it would be valuable to the project.

3. Code Contributions

We appreciate code contributions. To contribute code, please follow these steps:

  1. Fork the repository.
  2. Clone your forked repository to your local machine. 
    git clone https://github.com/prasoonk1204/cma-cli.git
  3. Create a new branch for your feature or bug fix. 
    git checkout -b feature/your-feature-name
    or 
    git checkout -b bugfix/your-bug-fix-name
  4. Make your changes.
  5. Test your changes thoroughly.
  6. Commit your changes with a clear and descriptive commit message. 
    git commit -m "feat: Add new feature"
    or 
    git commit -m "fix: Fix bug in X"
  7. Push your changes to your forked repository. 
    git push origin feature/your-feature-name
  8. Open a Pull Request to the main branch of the original repository.

4. Pull Request Guidelines

  • Ensure your code adheres to the project's coding style.
  • Write clear and concise commit messages.
  • Provide a detailed description of your changes in the pull request.
  • Ensure all tests pass.
  • Be responsive to feedback from maintainers.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Thank you for contributing!