docs: add contributing guide
This commit is contained in:
sbplat
parent
9fc873e973
commit
45aead89e3
2 changed files with 119 additions and 88 deletions
68
CONTRIBUTING.md
Normal file
68
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,68 @@
|
||||||
|
# Contributing to Stirling-PDF
|
||||||
|
|
||||||
|
Thank you for your interest in contributing to Stirling-PDF! There are many ways to contribute other than writing code. For example, reporting bugs, creating suggestions, and adding or modifying translations.
|
||||||
|
|
||||||
|
## Issue Guidelines
|
||||||
|
|
||||||
|
Issues can be used to report bugs, request features, or ask questions. If you have a question, you could also ask us in our [Discord](https://discord.gg/FJUSXUSYec).
|
||||||
|
|
||||||
|
Before opening an issue, please check to make sure someone hasn't already opened an issue about it.
|
||||||
|
|
||||||
|
## Pull Requests
|
||||||
|
|
||||||
|
Before you start working on an issue, please comment on (or create) the issue and wait for it to be assigned to you. If someone has already been assigned but didn't have the time to work on it lately, please communicate with them and ask if they're still working on it. This is to avoid multiple people working on the same issue.
|
||||||
|
|
||||||
|
Once you have been assigned an issue, you can start working on it. When you are ready to submit your changes, open a pull request.
|
||||||
|
For a detailed pull request tutorial, see [this guide](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github).
|
||||||
|
|
||||||
|
Please make sure your Pull Request adheres to the following guidelines:
|
||||||
|
|
||||||
|
- Use the PR template provided.
|
||||||
|
- Keep your Pull Request title succinct, detailed and to the point.
|
||||||
|
- Keep commits atomic. One commit should contain one change. If you want to make multiple changes, submit multiple Pull Requests.
|
||||||
|
- Commits should be clear, concise and easy to understand.
|
||||||
|
- References to the Issue number in the Pull Request and/or Commit message.
|
||||||
|
|
||||||
|
## Translations
|
||||||
|
|
||||||
|
Stirling PDF currently supports 26!
|
||||||
|
- English (English) (en_GB)
|
||||||
|
- English (US) (en_US)
|
||||||
|
- Arabic (العربية) (ar_AR)
|
||||||
|
- German (Deutsch) (de_DE)
|
||||||
|
- French (Français) (fr_FR)
|
||||||
|
- Spanish (Español) (es_ES)
|
||||||
|
- Simplified Chinese (简体中文) (zh_CN)
|
||||||
|
- Traditional Chinese (繁體中文) (zh_TW)
|
||||||
|
- Catalan (Català) (ca_CA)
|
||||||
|
- Italian (Italiano) (it_IT)
|
||||||
|
- Swedish (Svenska) (sv_SE)
|
||||||
|
- Polish (Polski) (pl_PL)
|
||||||
|
- Romanian (Română) (ro_RO)
|
||||||
|
- Korean (한국어) (ko_KR)
|
||||||
|
- Portuguese Brazilian (Português) (pt_BR)
|
||||||
|
- Russian (Русский) (ru_RU)
|
||||||
|
- Basque (Euskara) (eu_ES)
|
||||||
|
- Japanese (日本語) (ja_JP)
|
||||||
|
- Dutch (Nederlands) (nl_NL)
|
||||||
|
- Greek (el_GR)
|
||||||
|
- Turkish (Türkçe) (tr_TR)
|
||||||
|
- Indonesia (Bahasa Indonesia) (id_ID)
|
||||||
|
- Hindi (हिंदी) (hi_IN)
|
||||||
|
- Hungarian (Magyar) (hu_HU)
|
||||||
|
- Bulgarian (Български) (bg_BG)
|
||||||
|
- Sebian Latin alphabet (Srpski) (sr-Latn-RS)
|
||||||
|
|
||||||
|
If you would like to add or modify a translation, please see [How to add new languages to Stirling-PDF](HowToAddNewLanguage.md). Also, please create a Pull Request so others can use it!
|
||||||
|
|
||||||
|
## Fixing Bugs or Adding a New Feature
|
||||||
|
|
||||||
|
First, make sure you've read the section [Pull Requests](#pull-requests).
|
||||||
|
|
||||||
|
To build from source, please follow this [Guide](LocalRunGuide.md).
|
||||||
|
|
||||||
|
If, at any point of time, you have a question, please feel free to ask in the same issue thread or in our [Discord](https://discord.gg/FJUSXUSYec).
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
By contributing to this project, you agree that your contributions will be licensed under the [GPL 3 License](LICENSE). You also acknowledge and agree that your contributions will be included in Stirling-PDF and that they can be relicensed in the future under the MPL 2.0 (Mozilla Public License Version 2.0) license.
|
||||||
41
README.md
41
README.md
|
|
@ -16,8 +16,6 @@ Stirling PDF makes no outbound calls for any record keeping or tracking.
|
||||||
|
|
||||||
All files and PDFs exist either exclusively on the client side, reside in server memory only during task execution, or temporarily reside in a file solely for the execution of the task. Any file downloaded by the user will have been deleted from the server by that point.
|
All files and PDFs exist either exclusively on the client side, reside in server memory only during task execution, or temporarily reside in a file solely for the execution of the task. Any file downloaded by the user will have been deleted from the server by that point.
|
||||||
|
|
||||||
Please feel free to submit feature requests or report bugs either through GitHub issues or on our [Discord](https://discord.gg/Cn8pWhQRxZ)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
@ -146,44 +144,9 @@ Note: Podman is CLI-compatible with Docker, so simply replace "docker" with "pod
|
||||||
## Enable OCR/Compression feature
|
## Enable OCR/Compression feature
|
||||||
Please view https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToUseOCR.md
|
Please view https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToUseOCR.md
|
||||||
|
|
||||||
## Want to add your own language?
|
## Contributing (creating issues, translations, fixing bugs, etc.)
|
||||||
Stirling PDF currently supports 26!
|
|
||||||
- English (English) (en_GB)
|
|
||||||
- English (US) (en_US)
|
|
||||||
- Arabic (العربية) (ar_AR)
|
|
||||||
- German (Deutsch) (de_DE)
|
|
||||||
- French (Français) (fr_FR)
|
|
||||||
- Spanish (Español) (es_ES)
|
|
||||||
- Simplified Chinese (简体中文) (zh_CN)
|
|
||||||
- Traditional Chinese (繁體中文) (zh_TW)
|
|
||||||
- Catalan (Català) (ca_CA)
|
|
||||||
- Italian (Italiano) (it_IT)
|
|
||||||
- Swedish (Svenska) (sv_SE)
|
|
||||||
- Polish (Polski) (pl_PL)
|
|
||||||
- Romanian (Română) (ro_RO)
|
|
||||||
- Korean (한국어) (ko_KR)
|
|
||||||
- Portuguese Brazilian (Português) (pt_BR)
|
|
||||||
- Russian (Русский) (ru_RU)
|
|
||||||
- Basque (Euskara) (eu_ES)
|
|
||||||
- Japanese (日本語) (ja_JP)
|
|
||||||
- Dutch (Nederlands) (nl_NL)
|
|
||||||
- Greek (el_GR)
|
|
||||||
- Turkish (Türkçe) (tr_TR)
|
|
||||||
- Indonesia (Bahasa Indonesia) (id_ID)
|
|
||||||
- Hindi (हिंदी) (hi_IN)
|
|
||||||
- Hungarian (Magyar) (hu_HU)
|
|
||||||
- Bulgarian (Български) (bg_BG)
|
|
||||||
- Sebian Latin alphabet (Srpski) (sr-Latn-RS)
|
|
||||||
|
|
||||||
If you want to add your own language to Stirling-PDF please refer
|
|
||||||
https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md
|
|
||||||
|
|
||||||
And please create a PR to merge it back in so others can use it!
|
|
||||||
|
|
||||||
## How to View
|
|
||||||
1. Open a web browser and navigate to `http://localhost:8080/`
|
|
||||||
2. Use the application by following the instructions on the website.
|
|
||||||
|
|
||||||
|
Please see our [Contributing Guide](CONTRIBUTING.md)!
|
||||||
|
|
||||||
## Customisation
|
## Customisation
|
||||||
Stirling PDF allows easy customization of the app.
|
Stirling PDF allows easy customization of the app.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue