We want to make contributing to this project as easy and transparent as possible.
The most important part of this project are of course the data files containing the QMNIST digits and labels. It is important to understand that, in the interest of future reproducibility, these data files are frozen and cannot be modified. The only way to update the QMNIST data files to fix a serious error would be to release new data files under a new name. On the other hand, the code tnd the documentation can receive useful updates. For instance, the code that creates the qmnist files can be updated for portability as long as it regenerates exactly the same data files; the documentation can be made clearer or corrected for accuracy; etc.
We welcome your pull requests.
- Fork the repo and create your branch from
master. - If you've added code that should be tested, add and run tests.
- Update the documentation.
- If you haven't already, complete the Contributor License Agreement ("CLA").
In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Facebook's open source projects.
Complete your CLA here: https://code.facebook.com/cla
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. Facebook has a bounty program for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.
By contributing to QMNIST, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.