developer documentation #49

Any97Cris · 2025-06-09T21:02:17Z

No description provided.

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

vitormattos

I think that is Contribution guide

developer_manual/index.rst

developer_manual/guide-contribution.rst

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

developer_manual/contribution-guide.rst

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

developer_manual/contribution-guide.rst

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

vitormattos · 2025-06-16T16:06:41Z

developer_manual/contributing-guide.rst

@@ -0,0 +1,200 @@
+Contributing Guide


Looking now, sounds as duplicated of https://github.com/LibreSign/libresign/blob/main/CONTRIBUTING.md.

The developer manual is a contributing guide with more details of all steps. The CONTRIBUTING file at LibreSign repository could be reduced and I think that would be best to create here, at developer manual, the follow content that could be splitted into the files named with the root elements of this tree:

Translation

How translate LibreSign at Transifex

Add and/or change texts at LibreSign code using the L10N libraries. Would be good point to Nextcloud developer documentation at this point.

A quick instructions about how the translated text will go back to LibreSign repository

A warning talking that the l10n can't be changed

Setup environment
Will be necessary move part of https://github.com/LibreSign/libresign/blob/main/CONTRIBUTING.md to here and add a comment ato CONTRIBUTING.md pointing to here about the environment

Prerequirements

PHP version

Why use the minimum PHP version. We can't send a code using features that only works at newest version of PHP. LibreSign need to be compatible with minimum PHP version accepted by relative Nextcloud server version

how to set the PHP version at LibreCode environment

Node version and where is possible to check the place that have this information (package.json)

Other not mandatory dependencies but important to have and explain that the LibreCode Nextcloud docker environment already have the follow dependencies.

poppler-utils

locale charmap as UTF-8 at operational system

Branch policies

Expose about main and stable branches

Explain that the development is at main branch of LibreSign

Creating branch and suggestion about branch nomenclature

Commits

Conventional commits

Comments about conventional commits exposing a bit why we use this

possible issues about Conventional commits

DCO.

Expose why we use DCO.

Fixing possible issues about DCO

pull request

How to open

Instructions about destination branch

Possible issues about conventional commits and DCO and point to this documentation at the point that explain about this

I know that have a lot of contents. Maybe this could be made into separated commits and pull requests.

It is good to talk about bring the documentation inside libresign repository to here. Let me change the informations and send another commit.

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

vitormattos · 2025-06-16T20:00:36Z

developer_manual/contributing-guide.rst

+--------
+
+Welcome
+^^^^^^^^^^^^^^^^^^^^^^^^^^


Need to have the same char quantity of header.

vitormattos · 2025-06-16T20:00:41Z

developer_manual/contributing-guide.rst

@@ -0,0 +1,239 @@
+Contributing to LibreSign
+==================


Need to have the same char quantity of header.

vitormattos · 2025-06-19T15:36:44Z

developer_manual/contributing-guide.rst

+
+Before you get started, we encourage you to read our code of conduct, which describes our community norms:
+
+    * 1. `Our code of conduct < />`__, which explicitly stipulates that everyone must be gracious, respectful, and professional. This also documents our conflict resolution policy and encourages people to ask questions.


The link here is to https://github.com/LibreSign/libresign/blob/main/CODE_OF_CONDUCT.md

Please, verify and tell if this PR is ok. I bring all conduct code to #52

vitormattos · 2025-06-19T15:37:40Z

developer_manual/contributing-guide.rst

+If you would prefer to write code, you may wish to start with our list of good first issues for LibreSign. See the respective sections below for further instructions.
+
+
+Front and backend development environment


Suggested change

Front and backend development environment

Development environment

vitormattos · 2025-06-19T15:37:54Z

developer_manual/contributing-guide.rst

+Front and backend development environment
+++++++++++++++++++++++++++++++++++++++++
+
+This project depends on the NextCloud project, so to start writing code, you will need to set it up. We recommend using Docker for this, but feel free to use another method if you prefer. We suggest these two setups:


Suggested change

This project depends on the NextCloud project, so to start writing code, you will need to set it up. We recommend using Docker for this, but feel free to use another method if you prefer. We suggest these two setups:

This project depends on the Nextcloud project, so to start writing code, you will need to set it up. We recommend using Docker for this, but feel free to use another method if you prefer. We suggest these two setups:

vitormattos · 2025-06-19T15:42:17Z

developer_manual/index.rst

+   api
+   contributing-guide


This isn't a contribuding guide. The contributing guide is this:

https://github.com/LibreSign/libresign/blob/main/CONTRIBUTING.md

And we will need to move parts of CONTRIBUTING to documentation site to don't have duplicated content and also will be necessary have links from CONTRIBUTING to this documentation site.

Would be good to split this file into dedicated files to don't create the entire documentation into a single file.

I suggested here a tree of contents:

#49 (comment)

Please, verify and tell if this PR is ok. I bring all conduct code to #52

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

Any97Cris · 2025-06-20T21:02:18Z

Ok, I will follow the steps(#49 (comment)) in this commit(b0d8af3).

Not ready yet

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

create guite contribution

d6b31f2

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

Any97Cris requested review from vitormattos and samuelsonbrito June 9, 2025 21:02

Any97Cris self-assigned this Jun 9, 2025

vitormattos changed the title ~~create guite contribution~~ create git contribution Jun 10, 2025

vitormattos changed the title ~~create git contribution~~ create guide contribution Jun 10, 2025

vitormattos reviewed Jun 10, 2025

View reviewed changes

developer_manual/index.rst Outdated Show resolved Hide resolved

developer_manual/guide-contribution.rst Outdated Show resolved Hide resolved

name correction

36cbdf2

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

Any97Cris force-pushed the feat/contribution-pr-commit branch from fd2fd47 to 36cbdf2 Compare June 10, 2025 18:28

vitormattos requested changes Jun 10, 2025

View reviewed changes

developer_manual/contribution-guide.rst Outdated Show resolved Hide resolved

forms to contribute to libresign repository

9d41fea

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

Any97Cris requested a review from vitormattos June 10, 2025 20:37

vitormattos requested changes Jun 10, 2025

View reviewed changes

adjustment

74f0971

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

Any97Cris requested a review from vitormattos June 11, 2025 17:57

vitormattos reviewed Jun 16, 2025

View reviewed changes

Any97Cris marked this pull request as ready for review June 16, 2025 17:07

Any97Cris changed the title ~~create guide contribution~~ create contribution guide Jun 16, 2025

Any97Cris added 2 commits June 16, 2025 14:09

more information about contributing

beab8e3

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

change contributing steps

2b98657

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

Any97Cris requested a review from vitormattos June 18, 2025 19:15

vitormattos requested changes Jun 19, 2025

View reviewed changes

Any97Cris requested a review from vitormattos June 20, 2025 12:15

follow steps manual developer

b0d8af3

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

chore: steps to build developer manual documentation

fa88e50

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

Any97Cris changed the title ~~create contribution guide~~ developer documentation Jun 26, 2025

Any97Cris added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jun 26, 2025

Any97Cris marked this pull request as draft June 26, 2025 18:58

Any97Cris added 9 commits June 26, 2025 16:37

chore: adjustments

d731533

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

delete imagem tutorial

8119b36

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

delete imagem tutorial

d299702

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

developer_manual/images/transifex_main_screen.png

6a70768

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

delete contributing-guide file

a013f0c

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

put more information inside setup environment file

3a11167

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

remove link transifex

725d1cc

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

feature request screen

f5b5e6c

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

bug report screen

8f8a2f5

Signed-off-by: Crisciany Souza <crisciany.souza@librecode.coop>

		@@ -0,0 +1,239 @@
		Contributing to LibreSign
		==================


		Before you get started, we encourage you to read our code of conduct, which describes our community norms:

		* 1. `Our code of conduct < />`__, which explicitly stipulates that everyone must be gracious, respectful, and professional. This also documents our conflict resolution policy and encourages people to ask questions.

		If you would prefer to write code, you may wish to start with our list of good first issues for LibreSign. See the respective sections below for further instructions.


		Front and backend development environment

	Front and backend development environment
	Development environment

	This project depends on the NextCloud project, so to start writing code, you will need to set it up. We recommend using Docker for this, but feel free to use another method if you prefer. We suggest these two setups:
	This project depends on the Nextcloud project, so to start writing code, you will need to set it up. We recommend using Docker for this, but feel free to use another method if you prefer. We suggest these two setups:

Uh oh!

developer documentation #49

Are you sure you want to change the base?

developer documentation #49

Uh oh!

Conversation

Any97Cris commented Jun 9, 2025

Uh oh!

vitormattos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vitormattos Jun 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Any97Cris commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

vitormattos Jun 19, 2025 •

edited

Loading

Any97Cris commented Jun 20, 2025 •

edited

Loading