2017-02-14 22:40:04 +01:00
|
|
|
# Contributing to LibreTime
|
|
|
|
|
2021-06-08 13:36:47 +02:00
|
|
|
First and foremost, thank you! We appreciate that you want to contribute to
|
|
|
|
LibreTime, your time is valuable, and your contributions mean a lot to us.
|
2017-02-14 22:40:04 +01:00
|
|
|
|
2021-06-08 13:36:47 +02:00
|
|
|
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).
|
2017-02-14 22:40:04 +01:00
|
|
|
|
2021-06-08 13:36:47 +02:00
|
|
|
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.
|
2017-02-14 22:40:04 +01:00
|
|
|
|
2021-06-08 00:39:26 +02:00
|
|
|
**How to contribute**
|
2017-02-14 22:40:04 +01:00
|
|
|
|
2021-06-08 00:39:26 +02:00
|
|
|
- [Reporting bugs](#reporting-bugs)
|
|
|
|
- [Suggesting enhancements](#suggesting-enhancements)
|
2021-06-08 13:36:47 +02:00
|
|
|
- [Financially](https://libretime.org/contribute#financial)
|
|
|
|
- [Contributing to documentation](https://libretime.org/contribute#write-documentation)
|
|
|
|
- [Contributing to code](https://libretime.org/contribute#code)
|
2017-02-14 22:40:04 +01:00
|
|
|
|
2021-06-08 00:39:26 +02:00
|
|
|
## Reporting bugs
|
2017-02-14 22:40:04 +01:00
|
|
|
|
2021-06-08 00:39:26 +02:00
|
|
|
This section guides you through submitting a bug report for LibreTime.
|
2021-06-08 13:36:47 +02:00
|
|
|
Following these guidelines helps maintainers and the community understand your
|
|
|
|
report, reproduce the behavior, and find related reports.
|
2017-02-14 22:40:04 +01:00
|
|
|
|
2021-06-08 13:36:47 +02:00
|
|
|
Before creating bug reports, please check the following list, to be sure that
|
|
|
|
you need to create one:
|
2017-02-14 22:40:04 +01:00
|
|
|
|
2021-06-08 13:36:47 +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%3abug)**.
|
2021-06-03 14:17:10 +02:00
|
|
|
|
2021-06-08 13:36:47 +02:00
|
|
|
> **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.
|
2021-06-03 14:17:10 +02:00
|
|
|
|
2021-06-08 13:36:47 +02:00
|
|
|
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.
|
2021-06-08 00:39:26 +02:00
|
|
|
|
|
|
|
Bugs are tracked on the [official issue tracker](https://github.com/libretime/libretime/issues).
|
|
|
|
|
|
|
|
## Suggesting enhancements
|
|
|
|
|
2021-06-08 13:36:47 +02:00
|
|
|
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.
|
2021-06-08 00:39:26 +02:00
|
|
|
|
2021-06-08 13:36:47 +02:00
|
|
|
Before creating enhancement suggestions, please check the following list, as you
|
|
|
|
might find out that you don't need to create one:
|
2021-06-08 00:39:26 +02:00
|
|
|
|
2021-06-08 13:36:47 +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)**.
|
2021-06-08 00:39:26 +02:00
|
|
|
|
2021-06-08 13:36:47 +02:00
|
|
|
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.
|
2021-06-08 00:39:26 +02:00
|
|
|
|
2021-06-08 13:36:47 +02:00
|
|
|
## Code, documentation and financial contributions
|
2021-06-08 00:39:26 +02:00
|
|
|
|
2021-06-08 13:36:47 +02:00
|
|
|
More information about how to contribute code, documentation or financially
|
|
|
|
through our [OpenCollective](https://opencollective.com/libretime) can be found
|
|
|
|
on our [website](https://libretime.org/contribute).
|