erlang-language-platform/CONTRIBUTING.md
Roberto Aloi 5276f038b5 Add instructions on how to install ELP from source
Summary:
* Port and expand the instructions from the CONTRIBUTING file
* Point the CONTRIBUTING file to the new instructions

Reviewed By: alanz

Differential Revision: D53916555

fbshipit-source-id: 3098892ee7fadadece4b54890b234b7db59d14ff
2024-02-19 04:32:00 -08:00

1.4 KiB

Contributing to Erlang Language Platform

We want to make contributing to this project as easy and transparent as possible.

Our Development Process

ELP is currently developed in Meta's internal repositories and then exported out to GitHub by a Meta team member; however, we invite you to submit pull requests as described below.

Developing Locally

The gold standard is the current config in ci.yml.

You can find detailed instructions on how to compile ELP from source here.

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. If you haven't already, complete the Contributor License Agreement ("CLA").

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

Issues

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.

License

By contributing to Erlang Language Platform, you agree that your contributions will be licensed under the APACHE2 and MIT licenses in the root directory of this source tree.