Skip to content

Commit 2c91441

Browse files
Update docs to: 4128f477363a43225cb14a28228e306036912355
1 parent 64f55b7 commit 2c91441

1 file changed

Lines changed: 51 additions & 0 deletions

File tree

docs/contribution_types.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ abilities or find new way to contribute, feel free!
88
You can share your ideas about what you will do in [discussions](https://github.com/text-forge/text-forge/discussions)
99
to receive others comments to be sure about what you want or get tips.
1010

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.
1113

1214
## Programming
1315

@@ -28,4 +30,53 @@ and modularity, with knowledge about GDScript, C# or other languages Godot suppo
2830

2931
Change files structure needs change code in most cases, be sure your changes will not break anything!
3032

33+
## Writing Docs
3134

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).
64+
65+
## Extensibility Improvements
66+
67+
- Standardize API for adding new modes/plugins.
68+
- Document plugin/mode interface, Specially internal docs.
69+
- Make demo for plugin, mode or other modules.
70+
71+
## Performance Review
72+
73+
- Identify and address bottlenecks, especially for large file editing and multi-language support.
74+
75+
## User Experience
76+
77+
- Review UI/UX for consistency and accessibility.
78+
- Add onboarding guides and example configurations.
79+
80+
## Community Health
81+
82+
- Suggest issue/PR templates.

0 commit comments

Comments
 (0)