Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (27 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 1.44 KB

Contributing to APIF1DB

First off, thank you for considering contributing to APIF1DB! It's people like you that make this project great.

How Can I Contribute?

Reporting Bugs

If you find a bug, please open an issue on GitHub. Make sure to include:

  • A clear and descriptive title.
  • Detailed steps to reproduce the bug.
  • What you expected to happen and what actually happened.

Suggestions and New Features

If you have an idea for a new feature or an improvement to an existing one, please open an issue to discuss it.

Pull Request (PR) Process

To keep the project organized, please follow these steps:

  1. Fork the repository and create a new branch from main.
  2. Make your changes in your branch.
  3. Ensure your code adheres to the project's style and conventions.
  4. Submit your Pull Request.

Pull Request Titles

To make it easier to identify the nature of the changes, please use the following prefixes in your PR title:

  • ADD: For adding a new feature, endpoint, model, etc.
  • MDF: For modifying an existing functionality.
  • FIX: For fixing a bug.
  • DEL: For deleting code, files, or functionalities.
  • DOC: For documentation changes.
  • STYLE: For formatting, code style changes, etc., that do not alter logic.
  • REFACTOR: For refactoring code without changing its external behavior.

Example title: ADD: Endpoint to get circuits for a season

Thank you for your contribution!