Skip to content
This repository has been archived by the owner on Mar 19, 2024. It is now read-only.

Latest commit

 

History

History
54 lines (41 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

54 lines (41 loc) · 2.93 KB
Raw

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:

  1. Whether the same feature can be achieved without modifying vissl. VISSL is designed to be extensible so that it's easy to extend any modular component and train custom models. If some part is not as extensible, you can also bring up the issue to make it more extensible.
  2. Whether the feature is potentially useful to a large audience, or only to a small portion of users.
  3. Whether the proposed solution has a good design / interface.
  4. Whether the proposed solution adds extra mental/practical overhead to users who don't need such feature.
  5. Whether the proposed solution breaks existing APIs.

When sending a PR, please do:

  1. Fork the repo and create your branch from main.
  2. If a PR contains multiple orthogonal changes, split it to several PRs.
  3. If you've added code that should be tested, add tests.
  4. If you've changed APIs, update the documentation.
  5. Ensure the test suite passes. Follow cpu test instructions and [integration tests][https://github.com/facebookresearch/vissl/blob/main/dev/run_quick_tests.sh].
  6. Make sure your code follows our coding practices (see next section).
  7. 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.

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

License

By contributing to ssl_framework, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.