Emerald Caas Framework Contribution Guidelines

This repository contains Contribution Guidelines for Caas Framework in emerald project.

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 require support for improving the template add an issue to the template and contact the Owners/Maintainers of the repo.

Note: remember to change this section to match the support options for your project.

Roadmap

No future plans for this project appart from improving the template based on 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.