You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+21-7Lines changed: 21 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -2,16 +2,16 @@
2
2
3
3
Thank you for taking the time to contribute! Please follow these guidelines to ensure a smooth and productive workflow. 🚀🚀🚀
4
4
5
-
To get started with the project, please refer to the [README.md](https://github.com/suitenumerique/docs/blob/main/README.md) for detailed instructions.
5
+
To get started with the project, please refer to the [README.md](https://github.com/suitenumerique/docs/blob/main/README.md) for detailed instructions on how to run Docs locally.
6
6
7
-
Contributors are required to sign off their commits with `git commit --sign-off`: this confirms that they have read and accepted the [Developer's Certificate of Origin 1.1](https://developercertificate.org/).
7
+
Contributors are required to sign off their commits with `git commit --signoff`: this confirms that they have read and accepted the [Developer's Certificate of Origin 1.1](https://developercertificate.org/). For security reasons we also require [signing your commits with your SSH or GPG key](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) with `git commit -S`.
8
8
9
9
Please also check out our [dev handbook](https://suitenumerique.gitbook.io/handbook) to learn our best practices.
10
10
11
11
## Help us with translations
12
12
13
13
You can help us with translations on [Crowdin](https://crowdin.com/project/lasuite-docs).
14
-
Your language is not there? Request it on our Crowdin page 😊.
14
+
Your language is not there? Request it on our Crowdin page 😊 or ping us on [Matrix](https://matrix.to/#/#docs-official:matrix.org) and let us know if you can help with translations and/or proofreading.
15
15
16
16
## Creating an Issue
17
17
@@ -35,10 +35,14 @@ All commit messages must adhere to the following format:
35
35
36
36
`<gitmoji>(type) title description`
37
37
38
-
* <**gitmoji**>: Use a gitmoji to represent the purpose of the commit. For example, ✨ for adding a new feature or 🔥 for removing something, see the list here: <https://gitmoji.dev/>.
38
+
* <**gitmoji**>: Use a gitmoji to represent the purpose of the commit. For example, ✨ for adding a new feature or 🔥 for removing something, see the list [here](https://gitmoji.dev/).
39
39
***(type)**: Describe the type of change. Common types include `backend`, `frontend`, `CI`, `docker` etc...
40
-
***title**: A short, descriptive title for the change.
41
-
***description**: Include additional details about what was changed and why.
40
+
***title**: A short, descriptive title for the change
41
+
42
+
**⚠️ Make sure you add no space between the emoji and the (type) but add a space after the closing parenthesis of the type and use no caps!**
43
+
***description**: Include additional details on why you made the changes.
44
+
45
+
**⚠️ Commit description message are mandatory and shouldn't be too long**
42
46
43
47
### Example Commit Message
44
48
@@ -66,7 +70,9 @@ Please add a line to the changelog describing your development. The changelog en
66
70
It is nice to add information about the purpose of the pull request to help reviewers understand the context and intent of the changes. If you can, add some pictures or a small video to show the changes.
67
71
68
72
### Don't forget to:
69
-
- check your commits
73
+
- signoff your commits
74
+
- sign your commits with your key (SSH, GPG etc.)
75
+
- check your commits (see warnings above)
70
76
- check the linting: `make lint && make frontend-lint`
71
77
- check the tests: `make test`
72
78
- add a changelog entry
@@ -86,3 +92,11 @@ Make sure that all new features or fixes have corresponding tests. Run the test
86
92
If you need any help while contributing, feel free to open a discussion or ask for guidance in the issue tracker. We are more than happy to assist!
87
93
88
94
Thank you for your contributions! 👍
95
+
96
+
## Contribute to BlockNote
97
+
We use [BlockNote](https://www.blocknotejs.org/) for the text editing features of Docs.
98
+
If you find and issue with the editor you can [report it](https://github.com/TypeCellOS/BlockNote/issues) directly on their repo.
99
+
100
+
Please consider contributing to BlockNotejs, as a library, it's useful to many projects not just Docs.
101
+
102
+
The project is licended with Mozilla Public License Version 2.0 but be aware that [XL packages](https://github.com/TypeCellOS/BlockNote/blob/main/packages/xl-docx-exporter/LICENSE) are dual licenced with GNU AFFERO GENERAL PUBLIC LICENCE Version 3 and proprietary licence if you are [sponsor](https://www.blocknotejs.org/pricing).
0 commit comments