Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

42 lines (31 loc) · 2.43 KB
Raw

Contributing to awesome-metric-learning

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug / typo
  • Discussing the current state of the content
  • Submitting a new item to be listed
  • Proposing new content

We Publish with Github

We use github to host content, to track issues and content requests, as well as accept pull requests.

We Use Github Flow, So All Content Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the content (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. Add content under the proper section.
  3. Mark it with a domain tag such as NLP and/or CV, if applicable.
  4. Make sure that it is well formatted and grammatically correct.
  5. Issue that pull request!

Choose the right section for your contribution

We organize listings in several sections for easy navigation. Decide on the right section according the following guidelines:

  • Surveys: Detailed overviews of the field.
  • Applications: Working codebases to solve a specific problem.
  • Case Studies: Articles by well known companies and innovative startups detailing how they solve their problems.
  • Libraries: Well-crafted codebases with re-usable and generic utilities to solve certain types of problems.
  • Tools: Useful working applications that do not require interaction with the source code.
  • Approximate Nearest Neighbors: Implementations of relevant algorithms.
  • Papers: Seminal academic works that shape the field.
  • Datasets: Useful benchmarking data sources.

Any contributions you make will be under the Creative Commons Zero 1.0

In short, when you submit content changes, your submissions are understood to be under the same Creative Commons Zero License 1.0 that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs and / or typos. Report a bug by opening a new issue; it's that easy!

License

By contributing, you agree that your contributions will be licensed under its Creative Commons Zero License 1.0.