Skip to content

Commit b3ff653

Browse files
authored
Update 7.6.-How-to-contribute.md
1 parent b67402f commit b3ff653

1 file changed

Lines changed: 53 additions & 1 deletion

File tree

‎docs/doc/en/7.6.-How-to-contribute.md‎

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ path: 7.6.-How-to-contribute.md
44

55
# How to contribute
66

7+
78
## Contributing to the code {#contributing-to-the-code}
89

910
Please read the [contribution guidelines](https://github.com/ccbogel/QualCoder/blob/master/docs/CONTRIBUTING.md)
@@ -44,4 +45,55 @@ To translate:
4445
1. Create a language file (if one does not already exist) using this command: ```python rebuild_lang.py --create --lang LANGUAGE_CODE``` Please note that the names of your language files must comply with the [ISO 639-1](https://fr.wikipedia.org/wiki/Liste_des_codes_ISO_639-1) format.
4546
2. If a language file already exists, you can update the translations using ```python rebuild_lang.py --update --lang LANGUAGE_CODE```.
4647
3. You can edit the translations of the .po and .ts files in the src/i18n folder using the [Poedit](https://poedit.net/) software.
47-
4. Once the work is complete, compile to machine format using this command: ```python rebuild_lang.py --compile --lang LANGUAGE_CODE```.
48+
4. Once the work is complete, compile to machine format using this command: ```python rebuild_lang.py --compile --lang LANGUAGE_CODE```.
49+
50+
## Contributing in other ways: tutorials, videos, and case studies
51+
52+
Not every useful contribution to QualCoder is a line of code. The project also thrives thanks to the people who take the time to explain the software to others: by writing tutorials, producing videos, or sharing their experience and case studies. These contributions are precious, because they let a new user see concretely how the software is used, in a given discipline, language, or research setting, something no reference manual can cover on its own. If you use QualCoder in your work, you probably have something to pass on, and this page explains how.
53+
54+
### Writing a tutorial
55+
56+
A good tutorial does not list features: it walks through an example from start to finish, from the raw file to the analysis result. Particularly useful topics to cover:
57+
58+
- installation and first launch (Windows, macOS, GNU/Linux, or from source);
59+
- creating a project and organising files, cases, and attributes;
60+
- coding text, images, audio, and video;
61+
- importing surveys and processing questionnaire data;
62+
- queries, reports, inter-coder comparisons, and visualisations;
63+
- recent features, especially AI-assisted analysis, for which the documentation evolves quickly.
64+
65+
A few recommendations to keep your tutorial useful over time:
66+
67+
- **State the context**: QualCoder version, operating system, interface language. The software evolves quickly; a dated, versioned tutorial remains interpretable even after the interface changes.
68+
- **Work on sample data where possible**: a small fictional corpus is more pedagogical than a real project, and avoids any confidentiality issues.
69+
- **Illustrate the key steps** with screenshots, and describe the actions precisely (clicks, menus, shortcuts), including the stumbling blocks you hit when you were starting out.
70+
- **Write in your own language**: English-language resources are the most abundant; tutorials in French, Spanish, German, Portuguese, or other languages are especially welcome.
71+
72+
### Producing videos
73+
74+
Video is the most direct format for showing the gestures: creating a project, selecting an excerpt, coding, comparing, exporting. In a few minutes the user sees what lengthy documentation would laboriously describe.
75+
76+
For an effective video:
77+
78+
- announce the version used and the tutorial's goal right at the start;
79+
- favour short, focused videos (one task, one video), or a chaptered table of contents for longer presentations;
80+
- take care with audio quality and on-screen readability, and add subtitles where possible, which make the video accessible and translatable;
81+
- publish freely (YouTube, PeerTube...) and let the project team know about your video so it can be listed on the wiki's Vidéo tutorial's page.
82+
83+
## Sharing your experience or a case study
84+
85+
Telling the story of how you actually used QualCoder, in fieldwork, a thesis, a dissertation, or a workshop, answers the question every researcher asks before adopting a tool: "has this already been used, in a context like mine?". A case study does not need to be a methodological article: a few pages describing your discipline, your data, your methodology, the QualCoder features you relied on, and, honestly, the limitations you encountered, are already a valuable contribution. Comparisons with commercial software (NVivo, ATLAS.ti, MAXQDA) and accounts from teaching workshops are also highly sought after, as shown by the guides some universities have produced around QualCoder.
86+
87+
Two points of caution:
88+
89+
- **Confidentiality**: if you show real data, anonymise it and check that your study's consent framework allows this kind of publication;
90+
- **Traceability**: mention the version used and cite the software properly in your work (the GitHub repository provides the citation information).
91+
92+
## How to submit your contribution
93+
94+
No technical account or pull request is needed for these contributions. The simplest way:
95+
96+
1. **Open an issue** on the [QualCoder GitHub repository](https://github.com/ccbogel/QualCoder) describing what you would like to share; the team will tell you the best way to integrate it (wiki, blog, project website);
97+
2. **Or report it directly** to the team via the blog or the project's channels, especially if your content is already published online.
98+
99+
Your resource will then be listed in the documentation, so that as many people as possible benefit from it. And if, while writing, you discover ways the software or its documentation could be improved, that feedback is a contribution too: it feeds the project's roadmap.

0 commit comments

Comments
 (0)