2022-07-20 14:01:24 +00:00
|
|
|
Contributing to Overleaf
|
2014-02-08 19:40:56 +00:00
|
|
|
==========================
|
|
|
|
|
|
2014-02-13 13:21:36 +00:00
|
|
|
Thank you for reading this! If you'd like to report a bug or join in the development
|
2022-07-20 14:01:24 +00:00
|
|
|
of Overleaf, then here are some notes on how to do that.
|
2014-02-15 18:31:12 +00:00
|
|
|
|
2014-02-13 13:21:36 +00:00
|
|
|
Reporting bugs and opening issues
|
|
|
|
|
---------------------------------
|
2014-02-08 19:40:56 +00:00
|
|
|
|
2022-07-20 14:01:24 +00:00
|
|
|
If you'd like to report a bug or open an issue, please **[check if there is an existing issue](https://github.com/overleaf/overleaf/issues).**
|
|
|
|
|
If there is then please add any more information that you have, or give it a 👍.
|
2014-02-08 19:40:56 +00:00
|
|
|
|
2014-02-13 13:21:36 +00:00
|
|
|
When submitting an issue please describe the issue as clearly as possible, including how to
|
|
|
|
|
reproduce the bug, which situations it appears in, what you expected to happen, and what actually happens.
|
|
|
|
|
If you can include a screenshot for front end issues that is very helpful.
|
2014-02-08 19:40:56 +00:00
|
|
|
|
|
|
|
|
Pull Requests
|
|
|
|
|
-------------
|
|
|
|
|
|
2022-07-20 14:01:24 +00:00
|
|
|
See [our wiki](https://github.com/overleaf/overleaf/wiki)
|
|
|
|
|
for how to manage the Overleaf development environment and for our developer guidelines.
|
2014-02-21 20:36:33 +00:00
|
|
|
|
2014-02-08 19:40:56 +00:00
|
|
|
We love pull requests, so be bold with them! Don't be afraid of going ahead
|
2014-02-13 13:21:36 +00:00
|
|
|
and changing something, or adding a new feature. We're very happy to work with you
|
2022-07-20 14:01:24 +00:00
|
|
|
to get your changes merged into Overleaf.
|
2014-02-13 13:21:36 +00:00
|
|
|
|
2022-07-20 14:01:24 +00:00
|
|
|
If you're looking for something to work on, have a look at the [open issues](https://github.com/overleaf/overleaf/issues).
|
2014-02-13 13:21:36 +00:00
|
|
|
|
|
|
|
|
Security
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
Please do not publish security vulnerabilities publicly until we've had a chance
|
|
|
|
|
to address them. All security related issues/patches should be sent directly to
|
2019-04-10 15:15:41 +00:00
|
|
|
security@overleaf.com where we will attempt to address them quickly. If you're
|
2014-02-13 13:21:36 +00:00
|
|
|
unsure whether something is a security issue or not, then please be cautious and
|
2019-04-10 15:15:41 +00:00
|
|
|
contact us at security@overleaf.com first.
|
2014-02-08 19:40:56 +00:00
|
|
|
|
2014-02-24 12:55:27 +00:00
|
|
|
Contributor License Agreement
|
|
|
|
|
-----------------------------
|
|
|
|
|
|
2017-08-05 21:33:16 +00:00
|
|
|
Before we can accept any contributions of code, we need you to agree to our
|
2019-04-10 15:15:41 +00:00
|
|
|
[Contributor License Agreement](https://docs.google.com/forms/d/e/1FAIpQLSef79XH3mb7yIiMzZw-yALEegS-wyFetvjTiNBfZvf_IHD2KA/viewform?usp=sf_link).
|
2014-02-24 12:55:27 +00:00
|
|
|
This is to ensure that you own the copyright of your contribution, and that you
|
|
|
|
|
agree to give us a license to use it in both the open source version, and the version
|
2019-04-10 15:15:41 +00:00
|
|
|
of Overleaf running at www.overleaf.com, which may have additional changes.
|
