Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (23 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

30 lines (23 loc) · 1.31 KB

Contributing to Eval Factsheets

We want to make contributing to this project as easy and transparent as possible.

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.

Contributing a New Factsheet

This repository is an auxiliary tool for the Every Eval Ever (EEE) project. To contribute a factsheet for an evaluation:

  1. Use the Eval Factsheets tool to generate your factsheet (preferably in JSON format).
  2. Navigate to the Every Eval Ever repository.
  3. Find the folder corresponding to your evaluation in data/{eval_name}/.
  4. Add your generated factsheet file to that folder.
  5. Submit a Pull Request to the EEE repository.

Issues

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

License

By contributing to Eval Factsheets, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.