|
1 | 1 | .. _dev-index: |
2 | 2 |
|
3 | | -Developer Manual |
| 3 | +Developer manual |
4 | 4 | ================ |
5 | 5 |
|
6 | | -We really appreciate everyone who would like to contribute to the LibreSign project! There are many ways to contribute, including writing code, filing issues on GitHub, helping people, assisting in triaging, reproducing, or fixing bugs that people have filed, and enhancing our documentation. Also giving a star to the project is a really good way to help and donate. |
| 6 | +Thank you for your interest in contributing to LibreSign! |
7 | 7 |
|
8 | | -Before you get started, we encourage you to read our code of conduct, which describes our community norms: |
| 8 | +There are many ways to help our project: |
9 | 9 |
|
10 | | - * 1. `Our code of conduct <https://github.com/LibreSign/libresign/blob/main/CODE_OF_CONDUCT.md>`__, which explicitly stipulates that everyone must be gracious, respectful, and professional. This also documents our conflict resolution policy and encourages people to ask questions. |
| 10 | +- Write code or fix bugs |
| 11 | +- Test and reproduce reported issues |
| 12 | +- Improve the documentation |
| 13 | +- Translate to other languages |
| 14 | +- Share the security and privacy the word |
| 15 | +- Give a ⭐ on `GitHub <https://github.com/LibreSign/libresign>`_ |
11 | 16 |
|
| 17 | +If you want to go further, you can also support LibreSign through |
| 18 | +`GitHub Sponsors <https://github.com/sponsors/LibreSign/>`_. |
12 | 19 |
|
13 | | -Here you will find the documentation for developers. |
| 20 | +We provide professional support for companies as well. |
14 | 21 |
|
15 | | -Introduction |
16 | | -============ |
17 | | - |
18 | | -What is LibreSign? |
19 | | ------------------- |
20 | | - |
21 | | -LibreSign is a software package that provides a set of tools for working with digital signatures. It is designed to be easy to use and flexible, allowing you to integrate it into your own applications or use it as a standalone tool. |
22 | | - |
23 | | -About This Documentation |
24 | | ------------------------- |
25 | | - |
26 | | -This section is intended for developers who want to understand the architecture of LibreSign, contribute to the codebase, or integrate the solution with other systems. |
27 | | - |
28 | | -Here you will find: |
29 | | - |
30 | | - - An overview of the project's architecture and core technologies; |
31 | | - |
32 | | - - Instructions for setting up the development environment; |
33 | | - |
34 | | - - Code standards, folder structure, and best practices adopted in the project; |
35 | | - |
36 | | - - Detailed API documentation and usage examples; |
37 | | - |
38 | | -Guidelines for contributing to the source code and submitting improvements. |
39 | | - |
40 | | -Whether you're part of the team, an external contributor, or simply curious about how LibreSign works under the hood — this section is for you. |
41 | | - |
42 | | -Blog |
43 | | ----- |
44 | | - |
45 | | -Visit our `blog <https://libresign.coop/posts/>`__ |
| 22 | +For services or partnerships, please `contact us <https://libresign.coop/#contact>`_. |
46 | 23 |
|
| 24 | +Here you will find all the documentation for developers. |
47 | 25 |
|
48 | 26 | .. toctree:: |
49 | 27 | :maxdepth: 2 |
|
0 commit comments