Update submission instructions
-
Move content of README.md
to a separate file for data documentation. -
Populate README.md
with project summary and developer/submitter instructions. -
Include self-validation instructions:
from tests import load, validate, print_report
dfs = load('submissions/24k', to_csvs=True)
report = validate(dfs)
print_report(report)
The submission process looks something like this:
- Fork the repo.
- Add data to a new directory (
submissions/{first}-{last}-{name}
). - Or modify existing data as needed.
- Create a pull request.
- Commit further changes as needed until continuous integration tests pass.
- Merge pull request.
Edited by Ethan Welty