Skip to content

Contributing to gdcli

Thank you for considering contributing to gdcli! Your involvement helps improve the tool for the entire community.

How to Report a Bug

If you encounter any issues or bugs, please follow these steps:

  1. Check Existing Issues: Before creating a new issue, search the Issues to see if the problem has already been reported.

  2. Open a New Issue: If the issue hasn't been reported, open a new issue. Provide detailed information, including:

  3. Steps to reproduce the bug
  4. Expected behavior
  5. Actual behavior
  6. Screenshots or logs, if applicable

How to Suggest Enhancements

To propose new features or improvements:

  1. Check Existing Suggestions: Review the Issues to see if the enhancement has already been suggested.

  2. Open a New Issue: If not already suggested, open a new issue and select the "Feature Request" template. Provide a clear and detailed description of the enhancement, including:

  3. The motivation behind the suggestion
  4. How it benefits users
  5. Any relevant examples or use cases

How to Submit a Pull Request

If you'd like to contribute code changes:

  1. Fork the Repository: Click the "Fork" button at the top of the gdcli repository to create your own copy.

  2. Clone Your Fork: On your local machine, clone your forked repository: bash git clone https://github.com/your-username/gdcli.git cd gdcli

  3. Create a New Branch: Create a branch for your feature or bugfix: bash git checkout -b feature/your-feature-name

  4. Make Changes: Implement your changes, ensuring adherence to the project's coding standards.

  5. Commit Changes: Commit your changes with a descriptive message: bash git commit -m "Description of the feature or fix"

  6. Push to Your Fork: Push your changes to your forked repository: bash git push origin feature/your-feature-name

  7. Open a Pull Request: Navigate to the original gdcli repository and open a pull request. Provide a clear description of your changes and reference any related issues.

Additional Resources

We appreciate your contributions and efforts to improve gdcli!