Skip to content

Latest commit

 

History

History
75 lines (44 loc) · 5.93 KB

CONTRIBUTING.md

File metadata and controls

75 lines (44 loc) · 5.93 KB
Raw

Contributing to facebook360_dep

Thank you for your interest in contributing to facebook360_dep! From commenting on and triaging issues, to reviewing and sending Pull Requests, all contributions are welcome. We aim to build a vibrant and inclusive ecosystem of partners, core contributors, and community that goes beyond the main facebook360_dep GitHub repository.

The Open Source Guides website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful:

Code of Conduct

As a reminder, all contributors are expected to adhere to the Code of Conduct.

Ways to Contribute

If you are eager to start contributing code right away, we have a list of good first issues that contain bugs which have a relatively limited scope. As you gain more experience and demonstrate a commitment to evolving facebook360_dep, you may be granted issue management permissions in the repository.

There are other ways you can contribute without writing a single line of code. Here are a few things you can do to help out:

  1. Replying and handling open issues. Some issues may lack necessary information. You can help out by guiding people through the process of filling out the issue template, asking for clarifying information, or pointing them to existing issues that match their description of the problem.
  2. Reviewing pull requests for the docs. Reviewing documentation updates can be as simple as checking for spelling and grammar. If you encounter situations that can be explained better in the docs, click Edit at the top of most docs pages to get started with your own contribution.
  3. Help people write test plans. Some pull requests sent to the main repository may lack a proper test plan. These help reviewers understand how the change was tested, and can speed up the time it takes for a contribution to be accepted.

Each of these tasks is highly impactful, and maintainers will greatly appreciate your help.

Our Development Process

We use GitHub issues and pull requests to keep track of bug reports and contributions from the community. All changes from engineers at Facebook will sync to GitHub through a bridge with Facebook's internal source control. Changes from the community are handled through GitHub pull requests. Once a change made on GitHub is approved, it will first be imported into Facebook's internal source control and tested against Facebook's codebase. Once merged at Facebook, the change will eventually sync back to GitHub as a single commit once it has passed Facebook's internal tests.

Security Bugs

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.

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: Community License Agreement.

Contributing Code

Code-level contributions to facebook360_dep generally come in the form of pull requests. The process of proposing a change to facebook360_dep can be summarized as follows:

  1. Fork the facebook360_dep repository and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes, either locally or on CI once you opened a pull request.
  5. Make sure your code lints (for example via https://github.com/python/black for Python).
  6. Push the changes to your fork.
  7. Create a pull request to the facebook360_dep repository.
  8. Review and address comments on your pull request.
    1. A bot may comment with suggestions. Generally we ask you to resolve these first before a maintainer will review your code.
  9. If you haven't already, complete the Contributor License Agreement ("CLA").

If all goes well, your pull request will be merged. If it is not merged, maintainers will do their best to explain the reason why.

Step-by-step Guide

Whenever you are ready to contribute code, check out our step-by-step guide to sending your first pull request.

Tests

Tests help us prevent regressions from being introduced to the codebase. The GitHub repository is continuously tested, the results of which are available through the Checks functionality on commits and pull requests.

Community Contributions

Contributions to facebook360_dep are not limited to GitHub. You can help others by sharing your experience using facebook360_dep, whether that is through blog posts, presenting talks at conferences, or simply sharing your thoughts.

Where to Get Help

As you work on facebook360_dep, it is natural that sooner or later you may require help. In addition to the resources listed in SUPPORT, people interested in contributing may take advantage of the following:

  • Proposals Repository. If you are considering working on a feature large in scope, consider creating a proposal first as an Issue. The community can help you figure out the right approach, and we'd be happy to help.