Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (33 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

44 lines (33 loc) · 1.79 KB

Contributing to Edurata Workflows

Thank you for your interest in contributing to Edurata Workflows! This repository contains open-source templates primarily written in YAML files. We welcome contributions from the community to extend the library of templates and improve existing ones.

How to Contribute

1. Reporting Issues

  • Search existing issues before submitting a new one.
  • Clearly describe the issue, including steps to reproduce and expected behavior.

2. Submitting Pull Requests (PRs)

  • Fork the repository and create a new branch.
  • Follow the repository’s template structure and naming conventions.
  • Ensure YAML files are properly formatted and follow best practices.
  • Submit a PR with a clear description of your changes.

3. Template Standards

  • Use consistent YAML formatting (e.g., indentation, key naming).
  • Include relevant comments within templates where necessary.
  • Follow naming conventions for new templates.

4. Commit Message Format

  • Use descriptive commit messages.
  • Example: fix: corrected syntax error in deployment.yaml or feat: added CI/CD pipeline template.

5. Documentation Contributions

  • Help improve project documentation by submitting PRs.
  • Ensure clarity, correct formatting, and accuracy.

6. Community Guidelines

  • Be respectful and considerate of others.
  • Follow our Code of Conduct.

Getting Started

  1. Fork the repository.
  2. Clone your fork: git clone https://github.com/edurata/edurata-workflows.git
  3. Create a new branch: git checkout -b feature/your-template
  4. Make changes and commit: git commit -m "Your descriptive commit message"
  5. Push your changes: git push origin feature/your-template
  6. Submit a Pull Request.

Code of Conduct

By contributing, you agree to follow our Code of Conduct.