File: CONTRIBUTING.md

package info (click to toggle)
ghostwriter 1.8.1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 5,120 kB
  • sloc: cpp: 50,906; ansic: 3,530; javascript: 39; xml: 32; makefile: 8; sh: 3
file content (28 lines) | stat: -rw-r--r-- 2,077 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# Contributing

## Bug Reports

Bug reports are the number one way you can contribute to *ghostwriter*.  Please include the following information when filing a bug report in GitHub:

* Your Operating System
* If on GNU/Linux, your desktop environment
* Steps that can be used to replicate the problem
* Any sample Markdown files that might be useful in replicating the problem

## New Feature Requests

At this present time, I do not have the bandwidth to work on new feature requests.  As such, new feature requests filed in GitHub will be closed.  This does not mean *ghostwriter* will cease to have new features.  On the contrary!  *ghostwriter* has quite the backlog of feature requests already filed in GitHub.  Also, I have a secret list of features I would like to work on that I think the community will very much enjoy.  I do appreciate the community's enthusiasm for *ghostwriter*.  Thank you for all your feedback!

## Pull Requests

Pull requests are presently only accepted for translations into different languages.  I will be closing all other pull requests.  This is simply because I do not have the time that contributors deserve to review the code, let alone spend time thoroughly testing it.

## Translations

As stated above, pull requests are still accepted for translations into different languages.  Being a Qt application, *ghostwriter* requires translators to use Qt Linguist to create translation files.

## Packaging

*ghostwriter* still needs to be packaged for different GNU/Linux distributions.  If you are a maintainer for a GNU/Linux distribution, or would like to volunteer to become one, please consider packaging *ghostwriter* for your distribution's repository.

Finally, I am also looking for someone to contribute a regular MacOS build, as well as a Windows build.  While I am maintaining the Windows build releases at present, I would like to hand that off to someone else in the long term.  If you are interested, please let me know by filing a new Issue, and we can work together to get you started in creating the Windows executables.