Merge pull request #1 from radiorabe/feature/init-community

Problem: LibreTime needs initializing
This commit is contained in:
Robb 2017-02-22 22:31:04 -05:00 committed by GitHub
commit 95ce7ef880
2 changed files with 99 additions and 0 deletions

32
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,32 @@
# Contributing to LibreTime
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.
**What does "contributing" mean?**
Creating an issue is the simplest form of contributing to a
project. But there are many ways to contribute, including
the following:
* Updating or correcting documentation
* Feature requests
* Bug reports
Before opening an issue, please:
* read and be prepared to adhere to our [code of conduct](https://github.com/LibreTime/code-of-conduct/blob/CODE-OF-CONDUCT.md)
* 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:
* **version**: what version of LibreTime you were using when you experienced the bug?
* **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
fences](https://help.github.com/articles/creating-and-highlighting-code-blocks/).

67
README.md Normal file
View File

@ -0,0 +1,67 @@
# LibreTime
LibreTime is a community managed fork of the AirTime project.
It is managed by a friendly inclusive community of stations
from around the globe that use, document and improve LibreTime.
Join us in fixing bugs and in defining how we manage the
codebase going forward.
We are currently ramping up development on this repository.
Please note that LibreTime is released with a [Contributor Code
of Conduct](https://github.com/LibreTime/code-of-conduct/blob/CODE-OF-CONDUCT.md).
By participating in this project you agree to abide by its terms.
Please submit enhancements, bugfixes or comments via GitHub.
## Development Process
The LibreTime follows the standardized [Collective Code Construction
Contract (C4)](https://rfc.zeromq.org/spec:42/C4/). Its abstract is
provided here.
> C4 provides a standard process for contributing, evaluating and
> discussing improvements on software projects. It defines specific
> technical requirements for projects like a style guide, unit tests,
> git and similar platforms. It also establishes different personas
> for projects, with clear and distinct duties. C4 specifies a process
> for documenting and discussing issues including seeking consensus
> and clear descriptions, use of "pull requests" and systematic reviews.
The full text of the contract is licensed under the GPL and available at
the above link courtesy of the [ZeroMQ community](http://zeromq.org/).
## Releasing
The LibreTime maintainers release new versions of LibreTime at regular
intervals. We follow the [Semantic Versioning](http://semver.org/spec/v2.0.0.html)
standards.
In a nutshell, given a version number MAJOR.MINOR.PATCH we increment the:
1. MAJOR version when we make incompatible API changes,
2. MINOR version when we add functionality in a backwards-compatible manner, and
3. PATCH version when we make backwards-compatible bug fixes.
Given the history of the project we will be starting with version 3.0.0.
Stay tuned for early alphas and lots of betas as we get development
up and running.
## License
LibreTime is free software: you can redistribute it and/or
modify it under the terms of the GNU Affero General Public
License as published by the Free Software Foundation,
version 3 of the License.
## Copyright
Copyright (c) 2011-2017 Sourcefabric z.ú.
Copyright (c) 2017 LibreTime Community
Please refer to the original [README](README),
[CREDITS](CREDITS) and [LICENSE_3RD_PARTY](LICENSE_3RD_PARTY)
for more information.