Start by defining what the project is in paragraph form. Include information around what platform does(can be stolen from their GitHub), how does it run on(OpenShift, Kube, RHEL, Container, etc), and any general information that would be important to an IC or a PM.
Example: n8n is a workflow automation platform that gives technical teams the flexibility of code with the speed of no-code. With 400+ integrations, native AI capabilities, and a fair-code license, n8n lets you build powerful automations while maintaining full control over your data and deployments. This tool runs within podman conatainers. https://github.com/n8n-io/n8n
Provide any important steps you discovered along the way to actually install the project and get it successfully running on a platform.
NOTE: It is not a hard requirement to run a project on OpenShift or RHEL. Kube or Ubuntu could be used as well if the project focuses on those tools so that we still can understand the project without needing to make the investment on coding for our platforms.
Code blocks must be provided to allow for others the ability to install the item.
Example:
# docker volume create n8n_data
# docker run -it --rm --name n8n -p 5678:5678 -v n8n_data:/home/node/.n8n docker.n8n.io/n8nio/n8n
This could either be deploying the sample applications but the big thing here is to demonstrate the value in said product. This should be documented in code blocks allowing for repeatability. Your example artifacts can be also stored within your fork of this repository.
NOTE: Feel free to add any work arounds you had to do or extra credit open bugs upstream and place them within this README. This may give us some insight on how they handle issues.
# oc create my_example.yaml
Based on your hacking any opinions on the project provide in this section. As a team we will revisit these for a deeper discussion but it is important to define your thoughts on the project.
What potential wins could Red Hat get with investing in this project?