CONTRIBUTING.md 2.88 KB
Newer Older
James Allen's avatar
James Allen committed
1
2
3
Contributing to ShareLaTeX
==========================

James Allen's avatar
James Allen committed
4
5
Thank you for reading this! If you'd like to report a bug or join in the development
of ShareLaTeX, then here are some notes on how to do that.
James Allen's avatar
James Allen committed
6

James Allen's avatar
James Allen committed
7
*Note that ShareLaTeX is actually made up of many seperate repositories (a list is available
James Allen's avatar
James Allen committed
8
[here](https://github.com/sharelatex/sharelatex/blob/master/README.md#other-repositories)).* 
James Allen's avatar
James Allen committed
9

James Allen's avatar
James Allen committed
10
11
Reporting bugs and opening issues
---------------------------------
James Allen's avatar
James Allen committed
12

tomcoombs87's avatar
tomcoombs87 committed
13
If you'd like to report a bug or open an issue then please:
James Allen's avatar
James Allen committed
14

James Allen's avatar
James Allen committed
15
1. **Find the correct repository.** ShareLaTeX is split across multiple different repositories, each containing a different service (you can find a list of [all repositories here](https://github.com/sharelatex/sharelatex/blob/master/README.md#other-repositories)). If you know the bug only applies to one service, then please open an issue in that repository. For general bugs and issues that span more than one service, please open an issue in the [sharelatex/sharelatex](https://github.com/sharelatex/sharelatex) repository.
James Allen's avatar
James Allen committed
16
2. **Check if there is an existing issue.** If there is then please add
Ethan's avatar
Ethan committed
17
   any more information that you have, or give it a 👍.
James Allen's avatar
James Allen committed
18

James Allen's avatar
James Allen committed
19
20
21
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.
James Allen's avatar
James Allen committed
22
23
24
25

Pull Requests
-------------

John Lees-Miller's avatar
John Lees-Miller committed
26
See [our wiki](https://github.com/sharelatex/sharelatex/wiki)
James Allen's avatar
James Allen committed
27
for how to manage the ShareLaTeX development environment and for our developer guidelines.
James Allen's avatar
James Allen committed
28

James Allen's avatar
James Allen committed
29
We love pull requests, so be bold with them! Don't be afraid of going ahead
James Allen's avatar
James Allen committed
30
31
32
and changing something, or adding a new feature. We're very happy to work with you
to get your changes merged into ShareLaTeX.

John Lees-Miller's avatar
John Lees-Miller committed
33
If you're looking for something to work on, have a look at the open issues in any of the repositories listed [here](https://github.com/sharelatex/sharelatex/blob/master/README.md#other-repositories).
James Allen's avatar
James Allen committed
34
35
36
37
38
39

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
John Lees-Miller's avatar
John Lees-Miller committed
40
security@overleaf.com where we will attempt to address them quickly. If you're
James Allen's avatar
James Allen committed
41
unsure whether something is a security issue or not, then please be cautious and
John Lees-Miller's avatar
John Lees-Miller committed
42
contact us at security@overleaf.com first.
James Allen's avatar
James Allen committed
43

James Allen's avatar
James Allen committed
44
45
46
Contributor License Agreement
-----------------------------

Tom's avatar
Tom committed
47
Before we can accept any contributions of code, we need you to agree to our 
John Lees-Miller's avatar
John Lees-Miller committed
48
[Contributor License Agreement](https://docs.google.com/forms/d/e/1FAIpQLSef79XH3mb7yIiMzZw-yALEegS-wyFetvjTiNBfZvf_IHD2KA/viewform?usp=sf_link).
James Allen's avatar
James Allen committed
49
50
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
John Lees-Miller's avatar
John Lees-Miller committed
51
of Overleaf running at www.overleaf.com, which may have additional changes.