From e1d54af2da62fb45044aa0ab760057c9af32d5d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Such=C3=A1nek?= Date: Mon, 4 Jul 2022 09:51:30 +0200 Subject: [PATCH] Init repository --- CHANGELOG.md | 15 +++++++++++++++ CONTRIBUTING.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ LICENSE | 21 +++++++++++++++++++++ README.md | 20 ++++++++++++++++++++ SECURITY.md | 17 +++++++++++++++++ 5 files changed, 119 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 SECURITY.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..4b4bf84 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,15 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres +to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +- Initiated FAIR Data Station project + + +[Unreleased]: /../../compare/master...develop diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..894781a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,46 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other +method with the owners of this repository before making a change. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Pull Request Process + +1. Ensure any unnecessary install or build dependencies and other files are removed before the end of the layer when + doing a build. +2. Explain the changes and update the README.md file and other documentation if necessary. +3. Be ready to communicate about the Pull Request and make changes if required by reviewers. +4. The Pull Request may be merged once it passes the review and automatic checks. + +## Gitflow Workflow + +We use the standard [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow): + +* __master__ branch is used only for releases (and eventually hotfixes), this branch is also protected on GitHub (pull + requests with review and all checks must pass) +* __develop__ branch is used for development and as a base for following development branches of features, support + stuff, and as a base for releases +* __feature/*__ (base develop, rebase-merged back to develop when done) +* __chore/*__ (like the feature but semantically different, not the feature but some chore, e.g., cleanup or update of + Dockerfile) +* __fix/*__ (like the feature but semantically different, not something new but fix of a non-critical bug) +* __release/*__ (base develop, merged to master and develop when ready for release+tag) +* __hotfix/*__ (base master, merged to master and develop) + +Please note, that for tasks from [our Jira](https://dtl-fair.atlassian.net/projects/FDT/issues), we use such +as `[FDT-XX]` identifying the project and task number. + +## Release Management + +For the release management we use (aside from +the [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)): + +* [Semantic versioning](https://semver.org) +* Release Candidates - X.Y.Z-rc.N should be created if don’t expect any problems (in that case use alpha or beta), and + make a walkthrough to verify its functionality according to the manuals finally - it also verifies that the + documentation is up to date with the new version. +* [CHANGELOG.md](https://keepachangelog.com/en/1.0.0/ ) +* GitHub releases and tags - make the release using GitHub (or hub extension), CI will automatically upload ZIP and TGZ + distribution files there - better verify. +* Docker Hub image - in case of release, Docker image with the same tag will be created automatically. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4516cd7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 FAIR Data Team + +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, and/or 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..87fd9f2 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# FAIR Data Station + +*FAIR Data Station API* + +## Usage + +*To be done* + +## Development + +*To be done* + +## Contributing + +We maintain a [CHANGELOG](CHANGELOG.md), you should also take a look at our [Contributing Guidelines](CONTRIBUTING.md) +and [Security Policy](SECURITY.md). + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for more details. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..6940dfc --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,17 @@ +# Security Policy + +## Supported Versions + +Always use the latest version of FAIR Data Station (including patch version). +Older versions are not being patched as the upgrade process is straightforward. + +## Reporting a Vulnerability + +In case you find a vulnerability, please report it via issue or email as +soon as possible. + +You can directly propose a solution using a Pull Request (see [CONTRIBUTING](CONTRIBUTING.md) file). + +In case you need to provide also sensitive information related to a vulnerability, +please indicate that in the issue and we will let you know how to securely provide us +such information.