github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-12-24 02:51:17 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update CONTRIBUTING.md

Browse source
This commit is contained in:
James Allen 2014-02-13 13:21:36 +00:00
parent 3492e118fd
commit 6e150b1edc
1 changed files with 34 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
CONTRIBUTING.md
View file

@ -1,8 +1,40 @@
Contributing to ShareLaTeX Contributing to ShareLaTeX
========================== ==========================
Thank you for reading this! If you've found a bug, or have a new feature in mind, Thank you for reading this! If you'd like to report a bug or join in the development
then here are some notes on how to best report issues or implement changes. of ShareLaTeX, then here are some notes on how to do that.
Reporting bugs and opening issues
---------------------------------
If you'd like a report a bug or open an issue then please:
1. **Find the correct repository.** ShareLaTeX is split across multiple different repositories, each containing a different service (you can find a list [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.
2. **Check if there is an existing issue.** If there is then please add
any more information that you have, or give it a "+1" in the comments.
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.
Pull Requests
-------------
We love pull requests, so be bold with them! Don't be afraid of going ahead
and changing something, or adding a new feature. We're very happy to work with you
to get your changes merged into ShareLaTeX.
If you've got an idea for a change then please discuss it in the open first,
either by opening an issue, or by joining us in our
[development chat room](http://www.hipchat.com/g1nJMcj7b).
Developer Chat Room
-------------------
If you want to ask any questions in real-time, or get a feel for what's going on
then please drop into our [development chat room](http://www.hipchat.com/g1nJMcj7b).
If no one is online then you can still leave a message that will hopefully get a reply
when we return.
Security Security
-------- --------
@ -13,24 +45,3 @@ security@sharelatex.com where we will attempt to address them quickly. If you're
unsure whether something is a security issue or not, then please be cautious and unsure whether something is a security issue or not, then please be cautious and
contact us at security@sharelatex.com first. contact us at security@sharelatex.com first.
Reporting bugs
--------------
If you've found a bug then please:
1. Check if there is an existing issue for it. If there is then please add
any more information that you have, or give it a "+1".
2. If there is there is no issue, then please open one.
3. 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.
4. Please include a screenshot for front end issues if you can.
Pull Requests
-------------
We love pull requests, so be bold with them! Don't be afraid of going ahead
and changing something, or adding a new feature. If you're setting of to make
a big change then opening an issue (or commenting on an existing one) is the
best way to discuss your ideas first.