Repository Creation Guidelines for Scientific Articles

1. Repository Name

• It should be descriptive and concise.
• Use - to separate words. Example: CBA2024-TinyML-OBDII
• Avoid special characters and accents.

2. Repository Structure

/repository-name
  ├── docs/               # Documentation and guides
  ├── src/                # Source code
  ├── tests/              # Automated tests
  ├── data/               # Dataset (if applicable)
  ├── notebooks/          # Jupyter Notebooks (if applicable)
  ├── results/            # Model outputs and results
  ├── LICENSE             # Repository license
  ├── README.md           # Main documentation
  ├── requirements.txt    # Project dependencies (Python)
  ├── .gitignore          # Files to be ignored by Git

3. README.md

The README should include:

• Research group banner:
• Title: Project name.
• Description: Summary of objectives and functionalities.
• Article Information: Article title, authors, conference/journal, abstract, and link to the full article.
• Installation: Steps to configure and install dependencies.
• Reproducing Results: Detailed instructions on how to run the code to reproduce the experiments described in the article.
• Usage: Examples of code execution.
• Contribution: Guidelines for contributors.
• License: Type of license used.

4. Versioning and Branches

• Use main for the stable version.
• Create branches for development (feature/new-feature).
• Use pull requests to merge changes.

5. Code Standards

• Follow best practices for programming and formatting.
• For Python, use black and flake8.
• Follow the Conventional Commits standard for commits.

6. Licensing

• Define an appropriate license (MIT, Apache 2.0, GPL, etc.).
• Include the LICENSE file in the repository.

7. Documentation

• Create detailed documentation in the docs/ directory.
• Use tools like MkDocs or Sphinx for structured documentation.
• Explain methods, models, and approaches used in the article.

8. Testing and CI/CD

• Create automated tests in tests/.
• Set up continuous integration (GitHub Actions, GitLab CI/CD).

9. Dependency Management

• List dependencies in requirements.txt (Python) or package.json (Node.js).
• Use virtual environments (venv, conda).

Following these guidelines ensures a well-structured and reproducible repository for scientific research.