This is a repository template to manage the requirements analysis. For information regarding the Configuration of this repository please look through the CONFIGURATION.md.
In this file a README Template will follow:
This repository serves as the general collection point for NFDI4Energy [TODO_Type] requirements. The collection was set up as part of the NFDI4Energy Consortia.
Table of Contents
The requirements are listed in a single .csv file inside this repository. Two other important files are this README.md file, containing the information you are reading right now, as well as the Metadata Schema.md file, that lists the Metadata Schema we use.
The rest of the files in this repository are used to create a Website that can be used to look at the Requirements.
To look through the requirements there are two options. You can go to this [website](TODO LINK). The site was built using GitHub Pages. It should look like this:
On this website you can see a interactive table, this table can be sorted according to the different columns and also searched throuh the search bar.
Another way to look through the requirements is by downloading the .csv file and opening it locally on your computer. The file can be opened by any current spreadsheet software such as Libre Office Calc or Microsoft Excel.
You can download it, by clicking on the requirement folder in the repository and then the requirements.csv file in the repository, then start the download by clicking the download button.
Important
Anybody that has Requirements is encouraged to contribute to this collection, regardless if they are affiliated with NFDI4Energy or not.
To add Requirements to this collection there are three possible ways, which will be explained in the following sections. The only method not requiring a Github account is found in Contribute through an E-Mail.
The Reqirments must follow the Meadata Schema, there are optional fields and required fields, a requirement will not be accepted if all required fields are not filled in.
Note
A GitHub Account is needed for this Contribution Method.
This is the preffered method for adding a requirement into the collection and recommended for people not familiar with using git or csv files. This method consists of an issue being opened that contains the relevant requirement information. We have devised a special issue template, that will make adding the requirement easier. To add an issue simple go to Issues->New Issue on the repository github page.
Note
A GitHub Account is needed for this Contribution Method.
This is a secondary method for adding requirements, it is for users that are familiar with using git. It consists of the following steps:
- Creating a normal Issue [Todo add issue template]
- Cloning the repository
- Creating a branch from the main branch
- Adding the new requirements into the csv with the tool of your choice
- Pushing the changes
- Submitting a Pull Request
Note
No GitHub Account is needed for this Contribution Method.
If you do not want to use GitHub, you can still submit a requirement via E-Mail. Please get in touch with us through the following Mail: [TODO Add E-Mail]
The Metadata Schema can be found in the Metadata Schema.md. The different fields are also explained in the Markdown file.
Warning
Keep in mind, that some of the fields are optional, whil other are not. A requirement is only accepted when all required fields are filled in.
Here is a list of NFDI4Energy Requirements repositories:
- NFDI4Energy Requirements Repository Template
- NFDI4Energy Service Requirements
- NFDI4Energy Simulation Service Requirements
- NFDI4Energy Metadata Requirements
- TODO: Create Issue in Repository Template to add you repository