Skip to content
Finn Dilan edited this page Aug 18, 2023 · 2 revisions

NetSim Issue Tracking

Status

You can check the current status of our issues in the issues tab and comment on existing issues if you have further information to add.

New Issue

If you have anything to report (e.g. a bug you found, feature requests, or documentation enhancements), you can open a new issue and explain the details of the report. Please see the good first issue or issue template for more information.

Issue Template

Title: "Brief Description of the Issue"

Description:
A brief description of the topic or task that is well-suited for new contributors. Explain why this is marked as a "Good First Issue" and how it contributes to the project's improvement.

Task:
Describe the task in detail. This could be a simple task such as adding a small feature, fixing a typo, or updating documentation. Ensure that the instructions are clear and precise.

Difficulty Level:
Provide an assessment of the difficulty level of this task. Use terms like "easy," "moderate," or "challenging."

Prerequisites:
List any prerequisites that the contributor should fulfill in order to successfully complete this task. This could include basic knowledge of a specific programming language or familiarity with a certain part of the project.

Guidance:

  1. Step-by-step guide on how to approach the task.
  2. Additional instructions or tips that might be helpful.
  3. If applicable, include code examples, links, or resources.

Intended Outcome:
Describe what the contributor should achieve at the end once the task is successfully completed.

Note to Contributors:
Encourage contributors to leave comments on this issue if they have questions or uncertainties. Offer support and assistance.

Additional Information:
Include any extra information that might be relevant to the task.

Clone this wiki locally