diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 37491ab1ec..2de84405b3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -8,12 +8,8 @@ assignees: '' diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d9cc6a611d..1210a0ba36 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,7 +5,3 @@ ## Related issues / Pull Requests - -## Contributor Agreement - -- [ ] I confirm I have signed the [Contributor License Agreement](https://github.com/overleaf/overleaf/blob/main/CONTRIBUTING.md#contributor-license-agreement) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 774f860cc5..676456da17 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,38 +1,29 @@ -# Contributing to Overleaf +# Contributing to Overleaf CE+ Thank you for reading this! If you'd like to report a bug or join in the development -of Overleaf, then here are some notes on how to do that. +of Overleaf CE+, then here are some notes on how to do that. ## Reporting bugs and opening issues -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 you'd like to report a bug or open an issue, please **[check if there is an existing issue](https://github.com/yu-i-i/overleaf-cep).** If there is then please add any more information that you have, or give it a 👍. 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. -**Note**: If you are using [www.overleaf.com](www.overleaf.com) and have a problem, or if you would like to request a new feature, please contact the Support team at support@overleaf.com. Raise an issue here only to report bugs in the Community Edition release of Overleaf. ## Pull Requests -See [our wiki](https://github.com/overleaf/overleaf/wiki) +See [Overleaf wiki](https://github.com/overleaf/overleaf/wiki) for how to manage the Overleaf development environment and for our developer guidelines. 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 Overleaf. -If you're looking for something to work on, have a look at the [open issues](https://github.com/overleaf/overleaf/issues). +If you're looking for something to work on, have a look at the [open issues](https://github.com/yu-i-i/overleaf-cep/issues). ## Security -Please see [our security policy](https://github.com/overleaf/overleaf/security/policy) if you would like to report a potential security vulnerability. - -## Contributor License Agreement - -Before we can accept any contributions of code, we need you to agree to our -[Contributor License Agreement](https://docs.google.com/forms/d/e/1FAIpQLSef79XH3mb7yIiMzZw-yALEegS-wyFetvjTiNBfZvf_IHD2KA/viewform?usp=sf_link). -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 -of Overleaf running at www.overleaf.com, which may have additional changes. +Please see [Overleaf security policy](https://github.com/overleaf/overleaf/security/policy) if you would like to report a potential security vulnerability. diff --git a/CREDITS.md b/CREDITS.md new file mode 100644 index 0000000000..9df30fb10f --- /dev/null +++ b/CREDITS.md @@ -0,0 +1,70 @@ +# CREDITS + +This project includes ideas and adapted code from several open-source projects.\ +In most cases the original code has been modified, optimized, or extended. + +## Symbol palette + +The symbol palette feature is based on the original Overleaf implementation: + +https://github.com/overleaf/web/tree/master/frontend/js/features/symbol-palette + +The original code was slightly improved, particularly in the parts related to keyboard input. + +## LDAP authentication + +LDAP authentication was inspired by: + +https://github.com/smhaller/ldap-overleaf-sl + +The project provided the idea and part of the implementation for adding LDAP users to the user's contacts. + +## Autocomplete of reference keys + +Autocomplete of reference keys is based on: + +https://github.com/lcpu-club/overleaf + +The implementation largely follows the referenced code, except that a different `.bib` file parser is used. + +## Real-time track changes and comments + +The Track Changes and Comments feature exists largely in the original Overleaf codebase.\ +The missing parts were implemented based on: + +https://github.com/ertuil/overleaf + +The referenced code was fixed, optimized, and extended. + +## Sandboxed compiles + +The Sandboxed Compiles feature was until recently largely present in the original Overleaf codebase.\ +The missing parts were implemented in this project. + +## Import file from external URL + +The "From External URL" feature exists in the original Overleaf code.\ +The missing proxy component was implemented in this project. + +## Git integration + +Git integration is based on: + +https://github.com/ayaka-notes/overleaf-pro/tree/feat-git-bridge + +The backend was completely rewritten.\ +The frontend uses the referenced code, which was optimized and improved. + +## Original Features + +The following features are original work implemented in this project: + +- Template Gallery +- Advanced administrator tools for managing user accounts and projects +- SAML authentication +- OpenID Connect authentication + +## Acknowledgments + +Thanks to the users of the project for valuable feedback, suggestions, +and help in identifying and fixing bugs. diff --git a/README.md b/README.md index bff0037d71..f8e4799849 100644 --- a/README.md +++ b/README.md @@ -25,16 +25,17 @@ The present "extended" version of Overleaf CE includes: -- Template Gallery -- Sandboxed Compiles with TeX Live image selection +- Template gallery +- Sandboxed compiles with TeX Live image selection - LDAP authentication - SAML authentication - OpenID Connect authentication - Real-time track changes and comments - Autocomplete of reference keys -- Symbol Palette -- "From External URL" feature +- Symbol palette +- Import file from external URL - Advanced administrator tools for managing user accounts and projects +- Git integration > [!CAUTION] > Overleaf Community Edition is intended for use in environments where **all** users are trusted. Community Edition is **not** appropriate for scenarios where isolation of users is required due to Sandbox Compiles not being available. When not using Sandboxed Compiles, users have full read and write access to the `sharelatex` container resources (filesystem, network, environment variables) when running LaTeX compiles. @@ -74,11 +75,14 @@ folder are added. ## Authors -[The Overleaf Team](https://www.overleaf.com/about) -[yu-i-i](https://github.com/yu-i-i/overleaf-cep) — Extensions for CE unless otherwise noted +[The Overleaf Team](https://www.overleaf.com/about)\ +[yu-i-i](https://github.com/yu-i-i/overleaf-cep) — CE extensions; references to adapted code are listed in [`CREDITS`](CREDITS.md) ## License The code in this repository is released under the GNU AFFERO GENERAL PUBLIC LICENSE, version 3. A copy can be found in the [`LICENSE`](LICENSE) file. -Copyright (c) Overleaf, 2014-2025. +Copyright (c) Overleaf, 2014-2026.\ +Copyright (c) yu-i-i, 2024-2026, for CE extensions. + +Portions of the code are derived from other open-source projects; see [`CREDITS`](CREDITS.md). diff --git a/doc/screenshot.png b/doc/screenshot.png index 42a0602c2e..19f825c284 100644 Binary files a/doc/screenshot.png and b/doc/screenshot.png differ