mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2026-09-03 05:10:16 +03:00
briosandCopilot Autofix powered by AI
120678260a
# Description of Changes May spare some headaches down the line. Changes: - Added desktop dev command to the contributing guide <!-- Please provide a summary of the changes, including: - What was changed - Why the change was made - Any challenges encountered Closes #(issue_number) --> --- ## Checklist ### General - [X] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [X] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md) (if applicable) - [X] I have performed a self-review of my own code - [X] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### Translations (if applicable) - [ ] I ran [`scripts/counter_translation.py`](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/docs/counter_translation.md) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [X] I have run `task check` to verify linters, typechecks, and tests pass - [X] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#7-testing) for more details. --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
70 lines
3.5 KiB
Markdown
70 lines
3.5 KiB
Markdown
# 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).
|
|
|
|
## Development Quick Start
|
|
|
|
This project uses [Task](https://taskfile.dev/) as a unified command runner. After cloning:
|
|
|
|
1. Install the `task` CLI: https://taskfile.dev/installation/
|
|
2. Run `task install` to install all dependencies
|
|
3. Run `task dev` to start backend + frontend or `task desktop:dev` to start the desktop application
|
|
4. Run `task check` before submitting a PR
|
|
|
|
Run `task --list` to see all available commands.
|
|
|
|
## Pull Request Guidelines
|
|
|
|
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
|
|
|
|
If you would like to add or modify a translation, please see [How to add new languages to Stirling-PDF](devGuide/HowToAddNewLanguage.md). Also, please create a Pull Request so others can use it!
|
|
|
|
## Docs
|
|
|
|
Documentation for Stirling-PDF is handled in a separate repository. Please see [Docs repository](https://github.com/Stirling-Tools/Stirling-Tools.github.io) or use the "edit this page"-button at the bottom of each page at [https://docs.stirlingpdf.com/](https://docs.stirlingpdf.com/).
|
|
|
|
## Fixing Bugs or Adding a New Feature
|
|
|
|
First, make sure you've read the section [Pull Requests](#pull-requests).
|
|
|
|
If, at any point in time, you have a question, please feel free to ask in the same issue thread or in our [Discord](https://discord.gg/FJUSXUSYec).
|
|
|
|
## Developer Documentation
|
|
|
|
For technical guides, setup instructions, and development resources:
|
|
|
|
- [Developer Guide](DeveloperGuide.md) - Main setup and architecture guide
|
|
- [Taskfile.yml](Taskfile.yml) - Unified task runner for all build/dev/test/lint commands
|
|
- [Exception Handling Guide](devGuide/EXCEPTION_HANDLING_GUIDE.md) - Error handling patterns and i18n
|
|
- [Translation Guide](devGuide/HowToAddNewLanguage.md) - Adding new languages
|
|
- And more in the [devGuide folder](devGuide/)
|
|
|
|
For configuration and usage guides, see:
|
|
- [Database Guide](DATABASE.md) - Database setup and configuration
|
|
- [OCR Guide](HowToUseOCR.md) - OCR setup and configuration
|
|
|
|
## License
|
|
|
|
By contributing to this project, you agree that your contributions will be licensed under the [MIT License](LICENSE).
|