Emerald CaaS Framework Contribution Guidelines
This repository contains Contribution Guidelines for CaaS Framework in EMERALD project. NOTE: These guidelines were written for the project team, and sometimes refer to private repositories not publicly accesible.
Table of contents
- Table of contents
- Description
- Usage
- Support
- Roadmap
- Contributing
- Authors and acknowledgment
- License
- Project status
Description
This repository contains diferent utility guidelines on how to contribute to the Emerald CaaS Framework. The guidelines are divided into different sections, each one with a specific purpose.
- Enroll how to join to the repository for contributions.
- Component Development: Contains the guidelines for developing a new component for the CaaS Framework.
- Component Integration: Contains the guidelines for integrating a new component into the CaaS Framework.
- Component Validation: Contains the guidelines for validating a new component for the CaaS Framework.
- Keycloak Integration: Contains the guidelines for integrating Keycloak into the components of the CaaS Framework.
- Component Update: Contains the guidelines for updating a component of the CaaS Framework.
- Component Troubleshooting: Contains the guidelines for troubleshooting a component of the CaaS Framework.
- Semantic Versioning with Gitlab CI/CD: Contains the guidelines for versioning the components of the CaaS Framework.
- Component Publish with Gitlab CI/CD: Contains the guidelines for setting up the CI/CD pipeline for a component image publishing in gitlab.
Version: 1.0.0
Support
If you want to improve the guidelines, add an issue and contact the Owners/Maintainers of the repo.
Roadmap
No future plans for this project apart from improving the guidelines based on your feedback.
Contributing
In order to contribute to the project, you can fork the repository and create a merge request. The merge request will be reviewed by the project maintainers and if it is accepted it will be merged into the main branch.
Authors and acknowledgment
This project was developed by Tecnalia.
Thanks to:
- makeareadme.com for this template.
- Emerald Project for resources and inspiration.
- To be Continous for the CI/CD components.
- Gitlab CI/CD for the CI/CD documentation.
License
Read the license file for more information.
Project status
The project is in a stable state and is not actively being developed.