Raise Issues

Reporting Bugs and Requesting Enhancements

Open-source projects thrive on collaboration, and we’re excited to have you as part of the “Network as Code” community! If you find a bug, have a question, or want to suggest a new feature, raising an issue on GitHub is the best way to get involved.

In this article, we’ll walk you through the steps to effectively raise an issue, whether you’re reporting a bug or requesting an enhancement.

Why Raising Issues Matters

GitHub issues are the primary way to track bugs, enhancement requests, and discussions for open-source projects. By raising an issue, you’re helping us:

  • Identify and fix problems more quickly.
  • Prioritize features and enhancements that matter to the community.
  • Build a better product with the collective input of users and contributors.

Whether you’re an experienced contributor or new to GitHub, your input is invaluable!

How to Raise an Issue on GitHub

Follow these simple steps to raise an issue on our GitHub repository:

1. Check Existing Issues

Before creating a new issue, search the repository’s issues (e.g., https://github.com/netascode/terraform-aci-nac-aci) page to see if your bug or request has already been reported. This helps avoid duplicates and ensures discussions remain centralized.

  • If you find a similar issue, feel free to add a comment with additional details or +1 the request.
  • If you don’t see a relevant issue, proceed to create one.

2. Click “New Issue”

Navigate to the “Issues” tab of the repository and click the “New Issue” button. This will bring up the issue creation form.

3. Choose the Right Issue Template

Depending on the repository, you may see multiple templates (e.g., Bug Report, Feature Request, Question). Choose the template that best matches your issue. These templates are designed to guide you in providing the necessary information.

4. Fill Out the Details

For Bugs:

If you’re reporting a bug, include the following information:

  • Title: Provide a brief, descriptive title for the issue.
  • Description: Explain the bug clearly, including:
    • What you expected to happen.
    • What actually happened.
    • Steps to reproduce the issue.
  • Environment: Mention any relevant details, such as:
    • Operating system.
    • Software version.
    • Tools or frameworks being used.
  • Screenshots/Logs: If applicable, add screenshots, error messages, or logs to illustrate the issue.

For Feature Requests or Enhancements:

If you’re requesting a new feature or enhancement, include the following:

  • Title: Provide a concise title describing the feature.
  • Description: Clearly explain the feature or enhancement you’re requesting.
  • Use Case: Describe the problem it solves or the value it adds.
  • Additional Context: Add examples, mockups, or links that support your idea.

5. Submit the Issue

Once you’ve completed the form, review your details to ensure they’re clear and concise. Click the “Submit New Issue” button to post your issue.

What Happens Next?

Once your issue is submitted:

  1. Triage: Our team or community members will review your issue and may ask for additional details.
  2. Prioritization: If your issue is confirmed, it will be labeled and prioritized based on its impact.
  3. Resolution: Bugs will be fixed, and features will be added as part of future updates. You’ll receive notifications on GitHub for any updates related to your issue.

Tips for Raising Great Issues

  • Be Specific: Provide as much detail as possible to help us understand and reproduce the issue.
  • Be Respectful: We’re all here to collaborate and improve the project. Constructive feedback goes a long way.
  • Stay Engaged: If we ask for more information or clarification, your timely response helps us resolve the issue faster.

Thank You for Your Contributions!

Your feedback plays a crucial role in the success of “Network as Code”. By raising issues, you’re helping us create a better product and fostering a collaborative, open-source community.

Start Contributing Today!

Head over to our GitHub organization and let us know how we can improve. Together, we can build something amazing!