Add collaboration guide
AbandonedPublic

Authored by nibags on Sat, May 16, 10:07 AM.

Details

Summary

Add a file with instructions and basic information on how to collaborate in the repository.

The idea is to provide information for first-time contributors or who are only going to improve or fix some XML file without anything else. This file collects the doubts and errors that I have seen that some new contributors have had.

Any correction or improvement in the text is appreciated (especially, I would appreciate if you could check the wording).

Diff Detail

Repository
R216 Syntax Highlighting
Branch
add-collaboration-guide
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 27042
Build 27060: arc lint + arc unit
nibags created this revision.Sat, May 16, 10:07 AM
Restricted Application added projects: Kate, Frameworks. · View Herald TranscriptSat, May 16, 10:07 AM
Restricted Application added subscribers: kde-frameworks-devel, kwrite-devel. · View Herald Transcript
nibags requested review of this revision.Sat, May 16, 10:07 AM

I think this is very good thing to have.
But perhaps we just should add that to the README.md that is prominently shown on e.g. https://invent.kde.org/frameworks/syntax-highlighting
The README anyways already contains a "Adding unit tests for a syntax definition" that could be replaced with this.

nibags updated this revision to Diff 83086.Wed, May 20, 11:22 AM
  • Add collaboration guide in the README file

I put it all in the README. I also corrected the repository, I had not noticed that this repository was already in GitLab!