2020-05-22 23:34:32 +02:00
|
|
|
---
|
2021-06-08 13:37:35 +02:00
|
|
|
title: Contribute to LibreTime
|
2020-11-01 04:23:29 +01:00
|
|
|
layout: article
|
2020-11-03 05:14:27 +01:00
|
|
|
category: dev
|
|
|
|
|
permalink: /contribute
|
2020-05-22 23:34:32 +02:00
|
|
|
---
|
2020-05-19 03:34:56 +02:00
|
|
|
|
2021-06-08 13:37:35 +02:00
|
|
|
> LibreTime is a fork of AirTime due to stalled development of the open source
|
|
|
|
|
> version. For background on this, see this
|
|
|
|
|
> [open letter to the Airtime community](https://gist.github.com/hairmare/8c03b69c9accc90cfe31fd7e77c3b07d).
|
|
|
|
|
|
|
|
|
|
## Code of conduct
|
|
|
|
|
|
|
|
|
|
Before any contribution, read and be prepared to adhere to our
|
|
|
|
|
[code of conduct](https://github.com/libretime/code-of-conduct/blob/master/code_of_conduct.md).
|
|
|
|
|
|
|
|
|
|
In addition, LibreTime follow the standardized
|
|
|
|
|
[C4 development process](https://rfc.zeromq.org/spec:42/c4/), in which you can
|
|
|
|
|
find explanation about most of the development workflows for LibreTime.
|
2020-05-23 04:07:51 +02:00
|
|
|
|
2020-05-19 03:34:56 +02:00
|
|
|
## Bug reporting
|
|
|
|
|
|
2021-06-08 13:37:35 +02:00
|
|
|
Following these guidelines helps maintainers and the community understand your
|
|
|
|
|
report, reproduce the behavior, and find related reports.
|
|
|
|
|
|
|
|
|
|
Before creating bug reports, please check the following list, to be sure that
|
|
|
|
|
you need to create one:
|
|
|
|
|
|
|
|
|
|
- **Check the [LibreTime forum](https://discourse.libretime.org/)** for existing
|
|
|
|
|
questions and discussion.
|
|
|
|
|
- **Check that your issue does not already exist in the
|
|
|
|
|
[issue tracker](https://github.com/libretime/libretime/issues?q=is%3aissue+label%3abug)**.
|
|
|
|
|
|
|
|
|
|
> **Note:** If you find a **Closed** issue that seems like it is the same thing
|
|
|
|
|
> that you're experiencing, open a new issue and include a link to the original
|
|
|
|
|
> issue in the body of your new one.
|
|
|
|
|
|
|
|
|
|
When you are creating a bug report, please include as many details as possible.
|
|
|
|
|
Fill out the [required template](https://github.com/libretime/libretime/issues/new?labels=bug&template=bug_report.md),
|
|
|
|
|
the information it asks helps the maintainers resolve the issue faster.
|
|
|
|
|
|
|
|
|
|
Bugs are tracked on the [official issue tracker](https://github.com/libretime/libretime/issues).
|
|
|
|
|
|
|
|
|
|
## Suggesting enhancements
|
|
|
|
|
|
|
|
|
|
This section guides you through submitting an enhancement suggestion for
|
|
|
|
|
LibreTime, including completely new features and minor improvements to existing
|
|
|
|
|
functionality. Following these guidelines helps maintainers and the community
|
|
|
|
|
understand your suggestion and find related suggestions.
|
2020-05-19 03:34:56 +02:00
|
|
|
|
2021-06-08 13:37:35 +02:00
|
|
|
Before creating enhancement suggestions, please check the following list, as you
|
|
|
|
|
might find out that you don't need to create one:
|
2020-05-19 03:34:56 +02:00
|
|
|
|
2021-06-08 13:37:35 +02:00
|
|
|
- **Check the [LibreTime forum](https://discourse.libretime.org/)** for existing
|
|
|
|
|
questions and discussion.
|
|
|
|
|
- **Check that your issue does not already exist in the
|
|
|
|
|
[issue tracker](https://github.com/libretime/libretime/issues?q=is%3aissue+label%3afeature-request)**.
|
|
|
|
|
|
|
|
|
|
When you are creating an enhancement suggestion, please include as many details
|
|
|
|
|
as possible. Fill in [the template](https://github.com/libretime/libretime/issues/new?labels=feature-request&template=feature_request.md),
|
|
|
|
|
including the steps that you imagine you would take if the feature you're
|
|
|
|
|
requesting existed.
|
|
|
|
|
|
|
|
|
|
## Financial
|
|
|
|
|
|
|
|
|
|
LibreTime is run by volunteers who write code and manage the project in their
|
|
|
|
|
spare time. Financial contributions help us pay for our domain and back-end
|
|
|
|
|
infrastructure. It can also be used to cover the costs of development for
|
|
|
|
|
important features and conference attendance. If you wish to contribute
|
|
|
|
|
financially, you can do so through our
|
|
|
|
|
[OpenCollective](https://opencollective.com/libretime).
|
2020-05-19 03:34:56 +02:00
|
|
|
|
2020-11-28 03:39:16 +01:00
|
|
|
## Translation
|
2020-05-19 03:34:56 +02:00
|
|
|
|
2021-06-08 13:37:35 +02:00
|
|
|
LibreTime can run in over 15 different languages due to the gracious help of our
|
|
|
|
|
volunteers. Is your language not supported? Follow [this guide](/docs/interface-localization)
|
|
|
|
|
to add your language to LibreTime!
|
2020-05-19 03:34:56 +02:00
|
|
|
|
2020-11-28 03:39:16 +01:00
|
|
|
## Write documentation
|
2020-05-27 15:39:33 +02:00
|
|
|
|
2021-06-08 13:37:35 +02:00
|
|
|
One of the simplest ways to get started contributing to a project is through
|
|
|
|
|
improving documentation. LibreTime is constantly evolving, this means that
|
|
|
|
|
sometimes our documentation has gaps. You can help by adding missing sections,
|
|
|
|
|
editing the existing content so it is more accessible or creating new content
|
|
|
|
|
(tutorials, FAQs, etc).
|
|
|
|
|
|
|
|
|
|
Issues pertaining to the documentation are usually marked with the [Documentation](https://github.com/libretime/libretime/labels/documentation)
|
|
|
|
|
label.
|
|
|
|
|
|
|
|
|
|
Our site is built by Jekyll, which has an installation guide [here](https://jekyllrb.com/docs/installation/)
|
|
|
|
|
to help get you started. After cloning our repo locally, enter the `docs/`
|
|
|
|
|
directory and run
|
2020-06-27 17:36:58 +02:00
|
|
|
|
2020-05-27 15:39:33 +02:00
|
|
|
```
|
2020-06-27 17:36:58 +02:00
|
|
|
bundle install
|
2020-05-27 15:39:33 +02:00
|
|
|
jekyll serve
|
|
|
|
|
```
|
