From c8942acadb4593bd20e74ab8ea334bcf956c1536 Mon Sep 17 00:00:00 2001 From: Lucas Bickel Date: Tue, 14 Feb 2017 11:10:59 +0100 Subject: [PATCH 1/6] Very basic README.md That we can override the existing Sourcefabric README with an md extension comes in handy for our case. --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..caa256cb5 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# 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 direct your inquiries to the taiga or open an issue +in GitHub. + +## 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. From efa318b51eead6e63421902ddb7b1184f27a2cb0 Mon Sep 17 00:00:00 2001 From: Lucas Bickel Date: Tue, 14 Feb 2017 11:49:18 +0100 Subject: [PATCH 2/6] Add Contributor Code of Conduct As stated in I am adding a proper CoC to the project. Please direct changes to the CoC directly to the linked repo. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index caa256cb5..4ada17a4f 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ 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 direct your inquiries to the taiga or open an issue in GitHub. From 5b6114b140cc2edf98e39e7294df2fc36d3aec4c Mon Sep 17 00:00:00 2001 From: Lucas Bickel Date: Tue, 14 Feb 2017 11:59:18 +0100 Subject: [PATCH 3/6] Implement Semantic Versioning As per I am implementing semantic versioning. The docs in README is all that is needed, lets hope this works out to get a sustainable release process up and running fast. --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 4ada17a4f..b202aafb1 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,23 @@ By participating in this project you agree to abide by its terms. Please direct your inquiries to the taiga or open an issue in GitHub. +## 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 From 725da17bb7b1115048728a332f950f82cae439cc Mon Sep 17 00:00:00 2001 From: Lucas Bickel Date: Tue, 14 Feb 2017 14:27:10 +0100 Subject: [PATCH 4/6] Implement C4 As discussed on ... I am implementing the C4 standard by linking to the document in our main README.md. --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index b202aafb1..b2a042bc1 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,23 @@ By participating in this project you agree to abide by its terms. Please direct your inquiries to the taiga or open an issue in 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 From 1464a0f5134c11e53bd56bf437d638605d493d24 Mon Sep 17 00:00:00 2001 From: Lucas Bickel Date: Tue, 14 Feb 2017 22:40:04 +0100 Subject: [PATCH 5/6] Create CONTRIBUTING.md This adds a nice link on the issue and pr forms and is mostly pinched from https://github.com/update/update. I added clear references to C4 and our CoC and we can add more stuff like coding guidelines later on. --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..6599b652d --- /dev/null +++ b/CONTRIBUTING.md @@ -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/). From 4b4dc313f5f2fb6e5b03346aad8b1a6223ab3071 Mon Sep 17 00:00:00 2001 From: Lucas Bickel Date: Wed, 22 Feb 2017 10:32:47 +0100 Subject: [PATCH 6/6] Remove unlinked reference to taiga --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index b2a042bc1..56da79308 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,7 @@ 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 direct your inquiries to the taiga or open an issue -in GitHub. +Please submit enhancements, bugfixes or comments via GitHub. ## Development Process