We want to make contributing to this project as easy and transparent as possible.
We would greatly appreciate pull requests that:
- Replace fake data with real-world data. Please be careful to anonymize/sanitize any user data before putting your pull request on github.
- Add additional targets.
- Improve the performance of any supported engine. In practice, this probably means configuration changes.
All targets should be representative of actual usuage, visiting a variety of pages, with access patterns based on visitor logs. Additional dependencies/code should also be minimized - for example, the Wordpress target does not depend on any plugins (though one was used to generate the test data).
All development is on github; there are no Facebook-specific changes or code review practices.
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: 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 oss-performance, you agree that your contributions will be licensed under its MIT license.