Cookie AI CLI
npm

Contributing

Open an Issue

Encountering issues or bugs is a natural part of any software's lifecycle. Reporting these issues is a crucial step in helping us improve Cookie AI CLI. This guide will walk you through the process of opening an issue in an effective and helpful manner.

When to Open an Issue

You should open an issue for:

  • Bug Reports: If you find a bug or an unexpected behavior in Cookie AI CLI.
  • Feature Requests: If you have an idea for a new feature or an enhancement to an existing feature.
  • Documentation Improvements: Suggestions for improving or correcting the documentation.

How to Open an Issue

To open an issue, follow these steps:

  1. Visit the GitHub Repository: Go to the Cookie AI CLI GitHub repository.
  2. Check Existing Issues: Browse through existing issues to ensure your issue hasn’t already been reported or resolved.
  3. Use the Issue Template: When creating a new issue, use the provided issue template as a guide for your report.

Writing a Good Issue Report

A well-written issue report should include:

  • Clear Title: Use a descriptive title that summarizes the issue.
  • Detailed Description: Explain the problem or suggestion in detail. Include what you expected to happen and what actually happened.
  • Steps to Reproduce: If applicable, provide steps to reproduce the issue.
  • Environment Details: Include details about your environment, such as OS, version of Cookie AI CLI, and relevant dependencies.
  • Screenshots or Logs: Attach any relevant screenshots or output logs.

Example Issue Format

Title: [Bug/Feature] Short description of the issue

Description:

- Detailed explanation of the issue
- Steps to reproduce (if applicable)
- Expected behavior
- Actual behavior
- Environment details (OS, Cookie AI CLI version, etc.)
- Screenshots or logs (if applicable)

After Submitting an Issue

Once you've submitted an issue:

  • Monitor Your Issue: Stay active in the conversation. The development team or community members might ask for further information or clarification.
  • Be Patient: Remember that the team is working hard to resolve issues and implement new features.

Contributing Beyond Reporting

Apart from reporting issues, consider contributing in other ways such as submitting pull requests, improving documentation, or assisting others in the community. Your active participation is what makes the open-source community thrive.

Thank you for taking the time to report issues and help us improve Cookie AI CLI. Your input is valuable in making it a more robust and reliable tool for everyone.

Read the How to Contribute guide for more information on contributing to Cookie AI CLI.

Previous
How to contribute