Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (42 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

70 lines (42 loc) · 2.12 KB

Contributing to Git Helper CLI

Thank you for considering contributing to Git Helper CLI! Contributions are welcome from everyone.

Before contributing, please take a moment to review the following guidelines:

Code of Conduct

This project and everyone participating in it are governed by the Git Helper CLI Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to kingmohaemed@gmail.com.

How Can I Contribute?

Reporting Bugs

Before submitting a bug report, please ensure that:

  • You have searched for existing issues to prevent duplicates.
  • You are using the latest version of Git Helper CLI.

If you have found a bug, open an issue providing detailed information about the bug and steps to reproduce it.

Suggesting Enhancements

If you have an idea for an enhancement or new feature, open an issue to discuss it. Provide as much detail as possible, including examples and potential use cases.

Pull Requests

We welcome pull requests for bug fixes, enhancements, and new features. Before submitting a pull request:

  1. Fork the repository and create a new branch from cli.
  2. Make your changes, ensuring that your code follows the project's coding style and conventions.
  3. Write tests to cover your changes, if applicable.
  4. Ensure that all existing tests pass.
  5. Commit your changes with descriptive commit messages.
  6. Push your changes to your fork.
  7. Open a pull request, providing a detailed description of the changes.

Development Setup

To set up Git Helper CLI for local development, follow these steps:

  1. Clone your fork of the repository:

    git clone https://github.com/dom557/git-helper-cli.git

  2. Install the dependencies:

    cd git-helper-cli
npm install

  3. Make your changes and test them locally.

  4. Run tests:

    npm test

  5. Submit a pull request as described above.

License

By contributing to Git Helper CLI, you agree that your contributions will be licensed under the MIT License.

Thank you for your contributions!