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: docs/contribution_types.md
+51Lines changed: 51 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,8 @@ abilities or find new way to contribute, feel free!
8
8
You can share your ideas about what you will do in [discussions](https://github.com/text-forge/text-forge/discussions)
9
9
to receive others comments to be sure about what you want or get tips.
10
10
11
+
You can find contribution guides [CONTRIBUTING.md](https://github.com/text-forge/text-forge/blob/Main/CONTRIBUTING.md),
12
+
If you can't find the right guidance or have a question, [Discussions](https://github.com/text-forge/text-forge/discussions) are always available for guidance.
11
13
12
14
## Programming
13
15
@@ -28,4 +30,53 @@ and modularity, with knowledge about GDScript, C# or other languages Godot suppo
28
30
29
31
Change files structure needs change code in most cases, be sure your changes will not break anything!
30
32
33
+
## Writing Docs
31
34
35
+
This section is for all peoples, everyone can contribute in improve docs.
36
+
37
+
!!! Important
38
+
39
+
We use `text-forge/docs` repo to build and deploy our docs, this repo will sync automaticly with `docs/` folder in
40
+
main repo (`text-forge/text-forge`), so DON'T commit your changes based on docs repo! Just commit them same as regular changes.
41
+
42
+
- Sync external docs and internal docs (`docs/` folder with `##` docs in codes).
43
+
- Write uncompleted docs or do spell checks, etc.
44
+
45
+
## Testing
46
+
47
+
- Add or improve unit/integration tests.
48
+
- Improve CI/CD (GitHub Actions).
49
+
- Do manual test.
50
+
51
+
## Issue Triage
52
+
53
+
- Review existing issues, triage, and tag (bug, enhancement, doc, etc.).
54
+
- Close outdated or resolved issues.
55
+
56
+
!!! Note
57
+
58
+
If you are a new contributor and haven't premission to change tags and close issues, add comment in that issue and mention
59
+
someone with **Triage**, Write, Maintain, or Admin role, you can find them from [Contributors List](https://github.com/text-forge/text-forge/graphs/contributors).
60
+
61
+
## Code Quality
62
+
63
+
- Refactor for readability and maintainability (naming, file sizes, comments).
0 commit comments