Add contributing and security info, license under MIT

This commit is contained in:
Rumperuu 2021-03-20 10:24:59 +00:00
parent 4677bf0237
commit 63fd03fb96
3 changed files with 73 additions and 0 deletions

32
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,32 @@
This project welcomes contributions!
Please follow these guidelines when contributing, as it will give your pull
request the best chance of being accepted:
# Requesting Features/Reporting Bugs
- To request a new feature or to report a bug, create an
[Issue](https://github.com/Pear-Trading/Foodloop-Server/issues/new).
# Contributing Code
- This project uses [Git Flow](https://githubflow.github.io/);
- branch off of `development` to start developing (`git checkout -b <your branch>`);
- ensure that your new branch has a descriptive name and begins with your username;
- create a remote copy of your new branch (`git push`);
- create a draft [merge request](https://github.com/Pear-Trading/Foodloop-Server/compare);
to merge your branch with `development` — tag any related or to-close Issues; and
- when you think you're finished, un-draft your pull request.
# Commits
- This project uses [Conventional Commits](https://www.conventionalcommits.org); and
- keep individual commits as small as possible.
# Versioning
- This project uses [Semantic Versioning](https://semver.org/).
# Translating
- Translations are welcome!

21
LICENSE.md Normal file
View file

@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2016 creativeLabs Lukasz Holeczek.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the Software), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, andor sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

20
SECURITY.md Normal file
View file

@ -0,0 +1,20 @@
# Security Policy
## Supported Versions
The following versions of this software are currently being supported with
security updates:
| Version | Supported |
| ------- | ------------------ |
| 0.x.x | :white_check_mark: |
## Reporting a Vulnerability
To securely report a vulnerability, please DO NOT create an Issue on this
repository.
Please email [Mark Keating][mkeating] privately with the full details of the
vulnerability.
[mkeating]: mailto:m.keating@shadowcat.co.uk