From f9ee00b29b2374af2ee07df5f773af65ea658e81 Mon Sep 17 00:00:00 2001 From: Kacper Donat Date: Tue, 20 Apr 2021 23:07:44 +0200 Subject: [PATCH] Add contribution guidelines and CLA --- CLA.md | 71 +++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 38 +++++++++++++++++++++++ README.md | 19 ++++++++---- api/CONTRIBUTING.md | 3 ++ front/CONTRIBUTING.md | 3 ++ 5 files changed, 128 insertions(+), 6 deletions(-) create mode 100644 CLA.md create mode 100644 CONTRIBUTING.md create mode 100644 api/CONTRIBUTING.md create mode 100644 front/CONTRIBUTING.md diff --git a/CLA.md b/CLA.md new file mode 100644 index 0000000..4a8ef42 --- /dev/null +++ b/CLA.md @@ -0,0 +1,71 @@ +# Co Jedzie Individual Contributor License Agreement + +Adapted from http://www.apache.org/licenses/icla.txt © The Apache Software Foundation + +Thank you for your interest in Co Jedzie (the **"Project"**) by Kacper Donat (the **"Author"**). In order to clarify the +intellectual property license granted with Contributions from any person or entity, the Author must have a Contributor +License Agreement ("CLA") on file that has been signed by each Contributor, indicating agreement to the license terms +below. This license is for your protection as a Contributor as well as the protection of the Author and its users; it +does not change your rights to use your own Contributions for any other purpose. + +You accept and agree to the following terms and conditions for Your present and future Contributions submitted to the +Author. In return, the Author shall not use Your Contributions in a way that is contrary to the public benefit or +inconsistent with its bylaws in effect at the time of the Contribution. Except for the license granted herein to the +Author and recipients of software distributed by the Author, You reserve all right, title, and interest in and to Your +Contributions. + +1. Definitions. + - **"You"** (or **"Your"**) shall mean the copyright owner or legal entity authorized by the copyright owner that is + making this Agreement with the Author. For legal entities, the entity making a Contribution and all other entities + that control, are controlled by, or are under common control with that entity are considered to be a single + Contributor. For the purposes of this definition, **"control"** means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or + more of the outstanding shares, or (iii) beneficial ownership of such entity. + + - **"Contribution"** shall mean any original work of authorship, including any modifications or additions to an existing + work, that is intentionally submitted by You to the Author for inclusion in, or documentation of, any of the products + owned or managed by the Author (the **"Work"**). For the purposes of this definition, **"submitted"** means any form + of electronic, verbal, or written communication sent to the Author or its representatives, including but not limited + to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed + by, or on behalf of, the Author for the purpose of discussing and improving the Work, but excluding communication that + is conspicuously marked or otherwise designated in writing by You as **"Not a Contribution."** + +2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to the Author and + to recipients of software distributed by the Author a perpetual, worldwide, non-exclusive, no-charge, royalty-free, + irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, + sublicense, re-license, and distribute Your Contributions and such derivative works. + +3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to the Author and to + recipients of software distributed by the Author a perpetual, worldwide, non-exclusive, no-charge, royalty-free, + irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, + and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are + necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which + such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity ( + including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have + contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity + under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed. + +4. You represent that you are legally entitled to grant the above license. If your employer(s) has rights to + intellectual property that you create that includes your Contributions, you represent that you have received + permission to make Contributions on behalf of that employer, that your employer has waived such rights for your + Contributions to the Author, or that your employer has executed a separate Corporate CLA with the Author. + +5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of + others). You represent that Your Contribution submissions include complete details of any third-party license or + other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware + and which are associated with any part of Your Contributions. + +6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. + You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in + writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either + express or implied, including, without limitation, any warranties or conditions of TITLE, NON- INFRINGEMENT, + MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. + +7. Should You wish to submit work that is not Your original creation, You may submit it to the Author separately from + any Contribution, identifying the complete details of its source and of any license or other restriction (including, + but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and + conspicuously marking the work as "Submitted on behalf of a third-party: [named here]". + +8. You agree to notify the Author of any facts or circumstances of which you become aware that would make these + representations inaccurate in any respect. + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..040b0b0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# How to contribute? + +Thanks for your interest in the project! + +## I'd like to propose some feature / change... + +Cool! Go ahead, [create an issue] and describe your proposal so anyone can see it. You can also vote on features that +you want the most. + +## I've found a bug! + +Well, less cool! Before creating an issue, please check if the bug remains after hard refreshing (usually `ctrl+F5`) the +application. If the answer is yes, or this is not the first encounter of it please [create an issue] and describe the +problem. If you can, please attach screenshots (especially if this is visual bug), and console logs (especially for +connection problems) - this will help to reproduce the problem. + +## I've got some spare resources on my server... +Soon you will be able to help the project by hosting your own API node that will be available for clients to use. +More details to come soon. + +## I want to contribute some code... + +That's great! If you want to make changes to API (which is responsible for collecting and supplying applicaiton with +data) please check the [API contribution guidelines], if you are interested in UI side of the app please read the +[frontend contribution guidelines]. + +### Contributor License Agreement + +Unfortunately due to this project nature and license I need you to sign [Contributor License Agreement] - the nice thing +is that it can be done with simple push of a button! **You still will have full copyright to your contribution** but +basically you consent that you are entitled to code you are submitting and also to allow me to license this project on +other terms if needed to, for example, local governments. If you don't want to sign - I understand - but I won't be able +to accept your contribution :( + +[Contributor License Agreement]: ./CLA.md +[create an issue]: https://github.com/cojedzie/cojedzie/issues/new +[API contribution guidelines]: ./api/CONTRIBUTING.md +[frontend contribution guidelines]: ./front/CONTRIBUTING.md diff --git a/README.md b/README.md index 7bcd15a..be9b2a7 100644 --- a/README.md +++ b/README.md @@ -7,19 +7,26 @@ aims to be the central hub for all public transport information you will need. You can use the app at [cojedzie.pl](https://cojedzie.pl). -## Contributing -Want to contribute? - - ## Roadmap Co Jedzie is in active development, roadmap of the project can be found on [trello]. This roadmap is regularly updated -and represents current state of the project. Feel free to take a look. +and represents current state of the project. Feel free to take a look. + +### Contributing to roadmap +If you have found a bug or want to propose some changes feel free to create an [issue] explaining your proposal or +problem. Issue management and discussion would be done on the github, but planning will be carried away to the [trello] +trello with linked issue. + +## Contributing +Wan't to contribute? Nice! Please see [CONTRIBUTING.md] ## License This project is [fair-code](https://faircode.io/) licensed under [MIT with Commons Clause](./LICENSE.md). Basically, Co -Jedzie is free and code is available to everyone, but it's not allowed to make money directly with it. +Jedzie is free and code is available to everyone, but it's not allowed to make money directly with it without +authors permission. Note that data collected from available data sources is licensed by their respective owners, thus it may be available under different terms than the project itself and may require additional permissions to use. [trello]: https://trello.com/b/QXqDvmoG/co-jedzie +[issue]: https://github.com/cojedzie/cojedzie/issues/new +[CONTRIBUTING.md]: ./CONTRIBUTING.md diff --git a/api/CONTRIBUTING.md b/api/CONTRIBUTING.md new file mode 100644 index 0000000..6ca8468 --- /dev/null +++ b/api/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# Contributing guidelines + +TBD diff --git a/front/CONTRIBUTING.md b/front/CONTRIBUTING.md new file mode 100644 index 0000000..6ca8468 --- /dev/null +++ b/front/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# Contributing guidelines + +TBD