The SUMO challenge API is primarily a set of utilities to support participants in the SUMO challenge. As such, we do not anticipate significant ongoing development in this project. However, the software is not perfect, and we encourage participants to provide bug fixes if they identify any. We want to make contributing to this project as easy and transparent as possible.
If you would like to contribute to the sumo-api, please use the standard GitHub pull request process.
- 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: 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.
- For Python code, we use the PEP8 coding style guide
- For C++ code, please follow the style of the existing code.
By contributing to the SUMO challenge API, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.