icaerus-eu / icaerus-repo-template

ICAERUS GitHub repo template🦚

Template to copy-paste or take as an example for other ICAERUS GitHub repo's, orginating from WP2.



Report Bug - Request Feature

Table Of Contents

• Summary
• Readme requirements
• Repo requirements
• Authors
• Acknowledgments

Summary

This GitHub repository template is designed for the ICAERUS-EU project, providing a standardized structure for managing and sharing project-related code, documentation, and resources. It includes essential folders and files to help streamline development, collaboration, and tracking progress within the project.

Readme requirements

The idea is that this readme text is copied and adjusted for your own project-repo readme. Start by creating a repo on GitHub, from your GitHub account.

Header

You can copy-and-paste the header and shields directly into your own readme file (please change the repo-title in the urls to the correct ones).

<div align="center">
  <p>
    <a href="https://icaerus.eu" target="_blank">
      <img width="50%" src="https://icaerus.eu/wp-content/uploads/2022/09/ICAERUS-logo-white.svg"></a>
    <h3 align="center">TITLE OF YOUR REPO/PROJECT🦚</h3>
    
   <p align="center">
    Short description of the content/subject matter in the repository
    <br/>
    <br/>
    <a href="https://github.com/icaerus-eu/repo-title/wiki"><strong>Explore the wiki »</strong></a>
    <br/>
    <br/>
    <a href="https://github.com/icaerus-eu/repo-title/issues">Report Bug</a>
    -
    <a href="https://github.com/icaerus-eu/repo-title/issues">Request Feature</a>
  </p>
</p>
</div>

![Downloads](https://img.shields.io/github/downloads/icaerus-eu/repo-title/total) ![Contributors](https://img.shields.io/github/contributors/icaerus-eu/repo-title?color=dark-green) ![Forks](https://img.shields.io/github/forks/icaerus-eu/repo-titlee?style=social) ![Stargazers](https://img.shields.io/github/stars/icaerus-eu/repo-title?style=social) ![Issues](https://img.shields.io/github/issues/icaerus-eu/repo-title) ![License](https://img.shields.io/github/license/icaerus-eu/repo-title) 

Table of contents

We also expect a Table of Contents directly after the header, with linked section like the one in this repo, some ideas for sections are given below.

## Table Of Contents
- [Summary](#summary)
- [Introduction](#introduction)
- [Installation](#installation)
- [Usage](#usage)
- [Configuration](#configuration)
- [Contributing](#contributing)
- [Development](#development)
- [Testing](#testing)
- [Documentation](#documentation)
- [License](#license)
- [Support](#support)
- [Security](#security)
- [Acknowledgments](#acknowledgments)
- [Resources](#resources)
- [FAQ](#faq)
- [Gallery](#gallery)
- [Deployment](#deployment)
- [Demo](#demo)
- [Dependencies](#dependencies)
- [Known Issues](#known-issues)
- [Roadmap](#roadmap)

Please include the Acknowledgments section with EU-funding acknowledments.

## Acknowledgements
This project is funded by the European Union, grant ID 101060643.

<img src="https://rea.ec.europa.eu/sites/default/files/styles/oe_theme_medium_no_crop/public/2021-04/EN-Funded%20by%20the%20EU-POS.jpg" alt="https://cordis.europa.eu/project/id/101060643" width="200"/>

ICAERUS organization

You can decide later or immediately to publish it under the ICAERUS organization (if you are already a member). If your are not a member yet of this organization, please send an e-mail to [email protected] with your GitHub account information: email/username.

You can change it to the ICAERUS organization also later down the line if you are not immediatly ready yet. Make sure to change all the URLs in the headers, image, etc. to reflect this transfer: https://github.com/jurriandoornbos/uavgeo -> https://github.com/icaerus-eu/uavgeo

Repo requirements

License

Choose a license and LICENSE file. Preferably something open-source like GPL-v3.

Folder structure

From there on in, you can decide on folder structure which makes the most sense for the project. For some ideas of folder structures you can do some research, or use what is already logical to you/your organization.

Ideas:
- .github/                   # GitHub-specific files and templates
  - workflows/               # Workflow configuration files (e.g., CI/CD)
- docs/                      # Documentation files (e.g., user guides)
- src/                       # Source code for your project
- tests/                     # Test files
- data/                      # Data files (if applicable)
- config/                    # Configuration files
- scripts/                   # Utility scripts
- public/                    # Publicly accessible assets (e.g., web assets)
- dist/                      # Compiled or distribution files
- examples/                  # Example code or usage examples
- LICENSE                    # Your project's license file
- README.md                  # Repository README

You can also check out uavgeo for an example python project folder/file structure that is published and available through pip. Or p2p-ros for a ROS related project.

Topics

To help out findability, and usability in the ICAERUS platform (WP6), the repo's should be labeled correctly using GitHub Topics. These topics are still under construction and debate, but here is an idea of what we can use:

• UC related: uc1, uc2, uc3, uc4, uc5
• WP related: wp2, wp3, wp6
• Content related:
  • ml: Machine Learning (statistical learning)
  • dl: Deep Learning
  • cv: Computer vision
  • hsi/msi: Hyperspectral/Multispectral imaging
  • flight-control: Flight Control
  • path-planning: Path planning algorithms/implementations
  • dataset: Dataset related information/explanation/links/etc.
  • sim: Simulation related
  • framework: Framework/architectural/backbone code
  • ros: Robotics Operating System packages
• Topic related:
  • vineyards: Vineyards
  • spraying: Drone Spraying
  • forest:
• Location related:
  • spain
  • macedonia
• We should be able to come up with a lot more, and stick to these for the whole project.

Please choose no more than 10 Topics, although 3 or 4 should be able to cover the whole repo.

Authors

• Jurrian Doornbos - Wageningen University - Jurrian Doornbos

Acknowledgements

This project is funded by the European Union, grant ID 101060643.