From 0c3d478faf59cefebb78d58c43d966d096ebca62 Mon Sep 17 00:00:00 2001 From: scrummer Date: Tue, 2 Apr 2019 23:27:15 +0200 Subject: [PATCH] Added CLA-Assistant, updated github files --- .github/ISSUE_TEMPLATE.md | 12 +++++++ .github/PULL_REQUEST_TEMPLATE.md | 12 +++++++ CONTRIBUTING.md | 58 ++++++++++++++++++++++++++++++++ LICENSE => LICENSE.md | 2 +- README.md | 2 ++ 5 files changed, 85 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CONTRIBUTING.md rename LICENSE => LICENSE.md (96%) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..c481dec --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,12 @@ +| Q | A +| ---------------- | ----- +| Bug report? | yes/no +| Feature request? | yes/no +| BC Break report? | yes/no +| RFC? | yes/no + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..d6cb8ba --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,12 @@ +| Q | A +| ------------- | --- +| Bug fix? | yes/no +| New feature? | yes/no +| BC breaks? | no +| Deprecations? | yes/no +| Fixed tickets | #... + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e42decf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,58 @@ +# Contributing to Server-API + +## Bug Reports & Feature Requests + +* [Open an issue](https://github.com/labymod/labymod-server-api/issues) here on GitHub. +If you can, **please provide a fix and create a pull request (PR) instead**; this will automatically create an issue for you. +* Please be patient as not all items will be tested immediately - remember, LabyMod is developed by normal people like you. They have to work or go to school and LabyMod is only a product of their leisure time +* Occasionally we'll close issues if they appear stale or are too vague - please don't take this personally! +Please feel free to re-open issues we've closed if there's something we've missed and they still need to be addressed. + +## Contributing Pull Requests +PR's are even better than issues. +We gladly accept community pull requests. +There are a few necessary steps before we can accept a pull request: + +* [Open an issue](https://github.com/labymod/labymod-server-api/issues) describing the problem that you are looking to solve in +your PR (if one is not already open), and your approach to solving it (no necessary for bug fixes - only feature contributions). +* [Sign the CLA](https://cla-assistant.io/labymod/labymod-server-api) - see also below. +* [Send a pull request](https://help.github.com/articles/using-pull-requests/) from your fork’s branch to our `master` branch. + +## Contributor License Agreement +The following terms are used throughout this agreement: + +* **You** - the person or legal entity including its affiliates asked to accept this agreement. An affiliate is any +entity that controls or is controlled by the legal entity, or is under common control with it. + +* **Project** - is an umbrella term that refers to any and all LabyMod open source projects. + +* **Contribution** - any type of work that is submitted to a Project, including any modifications or additions to +existing work. + +* **Submitted** - conveyed to a Project via a pull request, commit, issue, or any form of electronic, written, or +verbal communication with LabyMod, contributors or maintainers. + +#### 1. Grant of Copyright License. +Subject to the terms and conditions of this agreement, You grant to the Projects’ maintainers, contributors, users and +to LabyMod a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, +prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your contributions and such +derivative works. Except for this license, You reserve all rights, title, and interest in your contributions. + +#### 2. Grant of Patent License. +Subject to the terms and conditions of this agreement, You grant to the Projects’ maintainers, contributors, users and +to LabyMod 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 your contributions, where +such license applies only to those patent claims licensable by you that are necessarily infringed by your contribution +or by combination of your contribution with the project to which this contribution was submitted. + +If any entity institutes patent litigation - including cross-claim or counterclaim in a lawsuit - against You alleging +that your contribution or any project it was submitted to constitutes or is responsible for direct or contributory +patent infringement, then any patent licenses granted to that entity under this agreement shall terminate as of the +date such litigation is filed. + +#### 3. Source of Contribution. +Your contribution is either your original creation, based upon previous work that, to the best of your knowledge, is +covered under an appropriate open source license and you have the right under that license to submit that work with +modifications, whether created in whole or in part by you, or you have clearly identified the source of the contribution +and any license or other restriction (like related patents, trademarks, and license agreements) of which you are +personally aware. diff --git a/LICENSE b/LICENSE.md similarity index 96% rename from LICENSE rename to LICENSE.md index e853da3..907b99c 100644 --- a/LICENSE +++ b/LICENSE.md @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2018 LabyMedia GmbH +Copyright (c) 2019 LabyMedia GmbH Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index f2ad95d..ef3e777 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # LabyMod Server API [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/LabyMod/labymod-server-api/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/LabyMod/labymod-server-api/?branch=master) +[![Discord](https://img.shields.io/discord/412724944112320513.svg)](https://labymod.net/dc/dev) +[![CLA assistant](https://cla-assistant.io/readme/badge/LabyMod/labymod-server-api)](https://cla-assistant.io/LabyMod/labymod-server-api) Our new Server API allows you to communicate between the LabyMod client and the server by using simple JSON messages. It also allows you to enable or disable LabyMod features. If you want to find out how our API works, visit https://docs.labymod.net/pages/server/introduction/