Contributing Guidelines

Thank you for considering contributing to SkyWizz! This document outlines the guidelines and conventions we follow when contributing to our project.

How to contribute

  1. Fork the repository to your own GitHub account.
  2. Clone the project to your local machine.
  3. Create a branch locally with a succinct but descriptive name.
  4. Work on the feature or bug.
  5. Commit changes in small, incremental steps.
  6. Push your branch to your forked repository.
  7. Make a pull request from your forked repository to the main repository.
  8. Have a discussion with the maintainers about the changes.

Commit messages

We use Conventional Commits for our commit messages, which provides a standardized format for describing the changes made in a commit.

A commit message should have the following format:

type(scope): subject

type: The type of change being made (e.g. feat, fix, docs, style, refactor, test, chore). scope (optional): The scope of the change (e.g. filename, module, package, etc.). subject: A brief description of the change. body (optional): A more detailed description of the change. footer (optional): A section for any related issue numbers or breaking changes.

Here are some examples:

feat(api): add new endpoint for getting airport distance

fix(gui): resolve issue with button not displaying correctly
 ```
```sql
docs: update README with new screenshots

Code Style

We use PEP 8 guidelines for Python code style. Please ensure your code follows these guidelines.

Documentation

We follow Google style for documentation.

Here is an example:

def add(a: Union[float, int], b: Union[float, int]) -> float:
    """Compute and return the sum of two numbers.

    Examples:
        >>> add(4.0, 2.0)
        6.0
        >>> add(4, 2)
        6.0

    Args:
        a (float): A number representing the first addend in the addition.
        b (float): A number representing the second addend in the addition.

    Returns:
        float: A number representing the arithmetic sum of `a` and `b`.
    """
    return float(a + b)

Issues and Bugs

If you find any issues or bugs with the project, please open a new issue in the GitHub issue tracker. Please provide as much detail as possible about the issue, including steps to reproduce it.