Support guidelines¶

This page explains the support mechanisms we provide.

Choose appropriate resources depending on what kind of help you need and read the detailed description in the sections below.

• Documentation sites
• Gathering information
• GitHub Issues
• Confirmed bugs
• Confirmed tasks

Guidelines for AVVV community support¶

If you encounter a problem with AVVV, please follow these steps to seek help:

1. Search for existing Issues and Questions¶

Before creating a new issue or question, check if someone else has already reported or asked about the problem. Use the following link:

• Issues

2. Create a new issue¶

If you don't find an existing issue or question that addresses your problem, create a new issue:

• Create issue

Documentation pages¶

Use Documents for a list of useful documentation pages. Visit them and see if there is any information related to your problem.

Note that the documentation sites aren't always up-to-date and perfect. If you find out that some information is wrong, unclear, or missing in docs, feel free to submit a pull request.

GitHub Issues¶

GitHub Issues is the designated platform for tracking confirmed bugs, tasks, and enhancements within AVVV's projects.

Follow these guidelines to ensure efficient issue tracking and resolution:

Reporting bugs¶

If you encounter a confirmed bug, please report it by creating an issue. Include detailed information such as steps to reproduce, expected outcomes, and actual results to assist maintainers in addressing the issue promptly.

Tracking tasks¶

GitHub Issues is also the place for managing tasks including:

• Refactoring: Propose refactoring existing code to improve efficiency, readability, or maintainability. Clearly describe what and why you propose to refactor.
• New Features: If you have confirmed the need for a new feature through discussions, use Issues to track its development. Outline the feature's purpose, potential designs, and its intended impact.
• Documentation: Propose changes to documentation to fix inaccuracies, update outdated content, or add new sections. Specify what changes are needed and why they are important.

Creating an issue¶

When creating a new issue, use the following guidelines:

1. Use Clear, Concise Titles: Clearly summarise the issue or task in the title for quick identification.
2. Provide Detailed Descriptions: Include all necessary details to understand the context and scope of the issue. Attach screenshots, error logs, and code snippets where applicable.
3. Tag Relevant Contributors: Mention contributors that might be impacted by or interested in the issue.

Linking issues and pull requests¶

When you start working on an issue, link the related pull request to the issue by mentioning the issue number. This helps maintain a clear and traceable development history.