Contributing to VISSL¶
We want to make contributing to this project as easy and transparent as possible.
Our Development Process¶
Minor changes and improvements will be released on an ongoing basis. Larger changes (e.g., changesets implementing a new SSL approach, benchmark, new scaling feature etc) will be released on a more periodic basis.
Issues¶
We use GitHub issues to track public bugs and questions. Please make sure to follow one of the issue templates when reporting any issues.
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.
Pull Requests¶
We actively welcome your pull requests.
However, if you’re adding any significant features (e.g. > 50 lines), please make sure to have a corresponding issue to discuss your motivation and proposals, before sending a PR. We do not always accept new features, and we take the following factors into consideration:
Whether the same feature can be achieved without modifying VISSL. VISSL is designed to be extensible. As VISSL is a research library, we want to encourage modular components that are easy to extend. If some part is not as extensible as you would like, you can flag this.
Whether the feature is useful to a larger audience or only to a small portion of users.
Whether the proposed solution has a good design / interface.
Whether the proposed solution adds extra mental/practical overhead to users who don’t need such a feature.
Whether the proposed solution breaks any existing APIs.
When sending a PR, please do:
Fork the repo and create your branch from
main.If a PR contains multiple orthogonal changes, split it to several PRs.
If you’ve added code that should be tested, add tests.
If you’ve changed APIs, update the documentation.
Ensure the test suite passes. Follow cpu test instructions and integration tests.
Please run the linter.
Make sure your code follows our coding practices (see next section).
If you haven’t already, complete the Contributor License Agreement (“CLA”).
Coding Style¶
Please follow our coding practices and choose either option to properly format your code before submitting PRs.