Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (47 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

71 lines (47 loc) · 1.76 KB
Raw

Contributing to FragDB

Thank you for your interest in contributing to FragDB! This document explains how you can help improve the database.

How to Contribute

Reporting Data Issues

If you find incorrect or missing data:

  1. Open an issue using the Bug Report template
  2. Include the fragrance ID (pid) if known
  3. Specify which field contains the error
  4. Provide the correct value with a source

Requesting New Fields

To suggest adding new data fields:

  1. Open an issue using the Feature Request template
  2. Describe the field and its purpose
  3. Explain how it would be useful
  4. Provide example values

Improving Examples

We welcome improvements to code examples:

  1. Fork this repository
  2. Make your changes in examples/
  3. Test with the sample data
  4. Submit a pull request

Documentation

Help improve our documentation:

  • Fix typos or unclear explanations
  • Add examples for edge cases
  • Translate documentation (future)

Code Example Guidelines

When contributing code examples:

  • Python: Use type hints, follow PEP 8
  • JavaScript: Use modern ES6+ syntax
  • SQL: Use standard SQL where possible
  • R: Use tidyverse conventions

All examples should:

  • Work with the sample data without modification
  • Include comments explaining key steps
  • Handle common edge cases
  • Be self-contained and runnable

Pull Request Process

  1. Ensure your code works with the sample files in samples/
  2. Update documentation if needed
  3. Describe your changes clearly
  4. Reference any related issues

Questions?

License

By contributing, you agree that your contributions will be licensed under the MIT License (for code examples) or become part of the FragDB documentation.