Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

75 lines (51 loc) · 3.2 KB
Raw

Contributing to The Little Book of ML Metrics

Thank you for your interest in contributing to The Little Book of ML Metrics Book! We welcome contributions from the community to help improve and expand this resource.

Disclaimer: The book is open-source, which means you can freely access the digital version. However, we also offer a high-quality printed edition for purchase. Revenue from printed copies helps support further development and maintenance of the book. Reviewers, contributors, and authors receive revenue sharing through their affiliate links.

Table of Contents

  1. Getting Started
  2. How to Contribute
  3. Reporting Issues
  4. Suggesting New Metrics
  5. LaTeX Guidelines
  6. Pull Request Process
  7. Code of Conduct

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Install the necessary LaTeX distribution and packages. These videos are really helpfull for setting up your local LaTeX environment. Windows, Mac. Make sure to compile the project using XeLaTex.
  4. Familiarize yourself with the project structure and existing content.

How to Contribute

There are several ways you can contribute to this project:

  • Reporting issues (typos, errors in metrics, unclear explanations, ect)
  • Suggesting new metrics to be included.
  • Adding new metrics (with proper LaTeX formatting)
  • Improving existing content
  • Fixing LaTeX-related issues
  • Enhancing figures or diagrams

Reporting Issues

If you find any issues, please create a new issue on GitHub with the following information:

  • A clear, descriptive title
  • A detailed description of the issue
  • The file and line number where the issue occurs (if applicable)
  • Any relevant screenshots or examples

Suggesting New Metrics

To suggest a new metric:

  1. Check if the metric is already included or planned.
  2. Create a new issue with the "Metric Suggestion" label.
  3. Provide the metric's name, formula, use cases, and any relevant references.

LaTeX Guidelines

When contributing LaTeX content:

  • Use consistent formatting with the existing document.
  • Follow the established style for equations, figures, and tables.
  • Use the defined custom commands and environments where applicable.
  • Ensure your LaTeX code compiles without errors.

Pull Request Process

  1. Create a new branch for your contribution.
  2. Make your changes in this branch.
  3. Ensure your code follows the project's style and guidelines.
  4. Submit a pull request with a clear title and description.

Claiming your Referall Link

Contact santiviquez at santiago@nannyml.com and he will issue you a referal link :)

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Thank you for contributing to The Little Book of ML Metrics!