Improve CONTRIBUTING and community links
- Enhance CONTRIBUTING.md file. - Add extra links to issue chooser.
This commit is contained in:
jo
parent
e8d5481422
commit
19b7573b6f
|
|
@ -0,0 +1,9 @@
|
||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: LibreTime Forum
|
||||||
|
url: https://discourse.libretime.org/
|
||||||
|
about: Please find existing questions and discussions here.
|
||||||
|
|
||||||
|
- name: LibreTime Chat
|
||||||
|
url: https://chat.libretime.org/
|
||||||
|
about: Discuss with the LibreTime community.
|
||||||
|
|
@ -1,41 +1,58 @@
|
||||||
# Contributing to LibreTime
|
# Contributing to LibreTime
|
||||||
|
|
||||||
First and foremost, thank you! We appreciate that you want to
|
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.
|
||||||
contribute to LibreTime, your time is valuable, and your
|
|
||||||
contributions mean a lot to us.
|
|
||||||
|
|
||||||
**What does "contributing" mean?**
|
Before any contibution, read and be prepared to adhere to our [code of conduct](https://github.com/libretime/code-of-conduct/blob/master/code_of_conduct.md).
|
||||||
|
|
||||||
Creating an issue is the simplest form of contributing to a
|
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.
|
||||||
project. But there are many ways to contribute, including
|
|
||||||
the following:
|
|
||||||
|
|
||||||
- Updating or correcting documentation
|
**How to contribute**
|
||||||
- Feature requests
|
|
||||||
- Bug reports
|
|
||||||
|
|
||||||
Before opening an issue, please:
|
- [Reporting bugs](#reporting-bugs)
|
||||||
|
- [Suggesting enhancements](#suggesting-enhancements)
|
||||||
|
- [Contributing to documentation](#contributing-to-documentation)
|
||||||
|
- [Contributing to code](#contributing-to-code)
|
||||||
|
|
||||||
- read and be prepared to adhere to our [code of conduct](https://github.com/LibreTime/code-of-conduct/blob/master/CODE_OF_CONDUCT.md)
|
## Reporting bugs
|
||||||
- understand that we follow the standardized [C4 development process](https://rfc.zeromq.org/spec:42/C4/)
|
|
||||||
- [search for existing duplicate or closed issues](https://github.com/LibreTime/libretime/issues?utf8=%E2%9C%93&q=is%3Aissue)
|
|
||||||
- clearly state the problem you would like to solve in a meaningful way
|
|
||||||
- be prepared to follow up on issues by providing additional information as requested by a maintainer or contributor helping you out
|
|
||||||
|
|
||||||
For bug reports, please provide the following details:
|
This section guides you through submitting a bug report for LibreTime.
|
||||||
|
Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
|
||||||
|
|
||||||
- **version**: what version of LibreTime you were using when you experienced the bug?
|
Before creating bug reports, please check the following list, to be sure that you need to create one:
|
||||||
- **distro**: what distribution is your install on and which distro version are you using (ie. Ubuntu Trusty)
|
|
||||||
- **reduced test case**: the minimum amount of detail needed to reproduce the bug
|
|
||||||
- **error messages**: please paste any error reports into the issue or a gist
|
|
||||||
|
|
||||||
Please wrap all code and error messages in [markdown code
|
- **Check the [LibreTime forum](https://discourse.libretime.org/)** for existing questions and dicscussion.
|
||||||
fences](https://help.github.com/articles/creating-and-highlighting-code-blocks/).
|
- **Check that your issue does not already exist in the [issue tracker](https://github.com/libretime/libretime/issues?q=is%3aissue+label%3abug)**.
|
||||||
|
|
||||||
### Contributing code
|
> **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.
|
||||||
|
|
||||||
To make sure that you don't accidentally commit code that does not follow the coding style, you can
|
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.
|
||||||
install a [`pre-commit`](https://pre-commit.com/) hook that will check that everything is in order:
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
Before creating enhancement suggestions, please check the following list, as you might find out that you don't need to create one:
|
||||||
|
|
||||||
|
- **Check the [LibreTime forum](https://discourse.libretime.org/)** for existing questions and dicscussion.
|
||||||
|
- **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.
|
||||||
|
|
||||||
|
## Contributing to documentation
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Contributing to code
|
||||||
|
|
||||||
|
LibreTime uses the [black](https://github.com/psf/black) coding style and you must ensure that your code follows it. If not, the CI will fail and your Pull Request will not be merged.
|
||||||
|
|
||||||
|
Similarly, the import statements are sorted with [isort](https://github.com/pycqa/isort) and special care must be taken to respect it. If you don't, the CI will fail as well.
|
||||||
|
|
||||||
|
To make sure that you don't accidentally commit code that does not follow the coding style, you can install a [`pre-commit`](https://pre-commit.com/) hook that will check that everything is in order:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pre-commit install
|
pre-commit install
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue