Skip to content

Latest commit

 

History

History
76 lines (49 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

76 lines (49 loc) · 3.33 KB
Raw

Contributing to Serverless Workflow Catalog

Thank you for your interest in contributing to the Serverless Workflow Catalog! We welcome contributions from the community to enhance the functionality and versatility of the catalog. This document outlines the process and guidelines for contributing.

Getting Started

To get started with contributing, please follow these steps:

  1. Fork the Repository

    • Click on the "Fork" button at the top right of the repository page to create a copy of the repository under your GitHub account.

  2. Clone Your Fork

    • Clone your forked repository to your local machine: 
      git clone https://github.com/YOUR_USERNAME/catalog.git

  3. Create a New Branch

    • Create a new branch for your changes: 
      git checkout -b my-feature-branch

  4. Make Your Changes

    • Implement your changes or additions. Ensure that your code adheres to the project's style and guidelines.

  5. Test Your Changes

    • Test your changes to ensure they work as expected and do not introduce new issues.

  6. Commit Your Changes

    • Commit your changes with a descriptive message: 
      git add .
git commit -m "Add new feature or fix issue"

  7. Push Your Changes

    • Push your changes to your forked repository: 
      git push origin my-feature-branch

  8. Submit a Pull Request

    • Go to the original repository on GitHub and open a pull request from your forked repository. Provide a clear description of your changes, the problem they solve, and any other relevant details.

Contribution Guidelines

To ensure consistency and quality in the Serverless Workflow Catalog, please follow these guidelines:

  • Function Naming: Use lowercase names with alphanumeric characters and hyphens (-) for function directories. Include the semantic version in the directory name (e.g., 1.0.0).

  • Documentation: Provide detailed documentation for your custom function. Include a README.md file with information about the function's purpose, parameters, usage examples, and any other relevant details.

  • Ownership: Create an OWNERS.md file to list the individuals or teams responsible for maintaining the function. Include their names and contact information.

  • Code Quality: Ensure your code is clean, well-documented, and follows best practices. Write unit tests if applicable.

  • Testing: Test your function thoroughly to ensure it integrates well with the Serverless Workflow DSL and performs as expected.

  • Commit Messages: Write clear and concise commit messages. Use the imperative mood and describe the purpose of the commit.

Review Process

  • Pull Request Review: After submitting a pull request, repository maintainers will review your changes. They may request modifications or provide feedback.

  • Approval and Merging: Once your pull request is reviewed and approved, it will be merged into the main repository. You will receive a notification once this is done.

Code of Conduct

Please adhere to the Code of Conduct when participating in discussions and making contributions.

Questions and Support

If you have any questions or need support, please open an issue on the repository or contact the repository maintainers.

Thank you for contributing to the Serverless Workflow Catalog!