We want to make contributing to this project as easy and transparent as possible.
We also welcome any fork attempt from this project.
ML-Logger has been developed mainly by Ge Yang and a few friends since May 2017.
Its future development will be conducted in this open source repo.
Please follow the steps when you find a bug:
- use the Github issue search to check if the issue has been addressed before.
- Make sure if the issue has been fixed by synchronizing the most recent branch in the repository.
- Write a simple and easy-to-understand test case that reveals the issue. 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.
We actively welcome your pull requests.
- Fork the repo and create your branch from
master. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- 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: [need link]
- PEP8 for python. js lint style guideline coming soon!
- 120 character line length
By contributing to ML-Logger, you agree that your contributions will be licensed under its BSD license.